Added @api tag for documentation

This commit is contained in:
Adrien Loison committed 2015-09-04 11:43:01 -07:00
1 parent 118810de22
commit f8c39287ad
30 files changed
+58 -14

No files matched your search

+3
View File
@@ -55,6 +55,7 @@ abstract class AbstractReader implements ReaderInterface
* Prepares the reader to read the given file. It also makes sure
* that the file exists and is readable.
*
* @api
* @param string $filePath Path of the file to be read
* @return void
* @throws \Box\Spout\Common\Exception\IOException If the file at the given path does not exist, is not readable or is corrupted
@@ -92,6 +93,7 @@ abstract class AbstractReader implements ReaderInterface
/**
* Returns an iterator to iterate over sheets.
*
* @api
* @return \Iterator To iterate over sheets
* @throws \Box\Spout\Reader\Exception\ReaderNotOpenedException If called before opening the reader
*/
@@ -107,6 +109,7 @@ abstract class AbstractReader implements ReaderInterface
/**
* Closes the reader, preventing any additional reading
*
* @api
* @return void
*/
public function close()
+1
View File
@@ -27,6 +27,7 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return RowIterator
*/
public function getRowIterator()
@@ -5,6 +5,7 @@ namespace Box\Spout\Reader\Exception;
/**
* Class IteratorNotRewindableException
*
* @api
* @package Box\Spout\Reader\Exception
*/
class IteratorNotRewindableException extends ReaderException
@@ -5,6 +5,7 @@ namespace Box\Spout\Reader\Exception;
/**
* Class NoSheetsFoundException
*
* @api
* @package Box\Spout\Reader\Exception
*/
class NoSheetsFoundException extends ReaderException
@@ -5,6 +5,7 @@ namespace Box\Spout\Reader\Exception;
/**
* Class ReaderNotOpenedException
*
* @api
* @package Box\Spout\Reader\Exception
*/
class ReaderNotOpenedException extends ReaderException
@@ -5,6 +5,7 @@ namespace Box\Spout\Reader\Exception;
/**
* Class SharedStringNotFoundException
*
* @api
* @package Box\Spout\Reader\Exception
*/
class SharedStringNotFoundException extends ReaderException
+3
View File
@@ -38,6 +38,7 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return RowIterator
*/
public function getRowIterator()
@@ -46,6 +47,7 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return int Index of the sheet, based on order of creation (zero-based)
*/
public function getIndex()
@@ -54,6 +56,7 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return string Name of the sheet
*/
public function getName()
+1
View File
@@ -18,6 +18,7 @@ class ReaderFactory
/**
* This creates an instance of the appropriate reader, given the type of the file to be read
*
* @api
* @param string $readerType Type of the reader to instantiate
* @return ReaderInterface
* @throws \Box\Spout\Common\Exception\UnsupportedTypeException
+3
View File
@@ -36,6 +36,7 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return RowIterator
*/
public function getRowIterator()
@@ -44,6 +45,7 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return int Index of the sheet, based on order of creation (zero-based)
*/
public function getIndex()
@@ -52,6 +54,7 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return string Name of the sheet
*/
public function getName()