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
@@ -44,6 +44,7 @@ class Sheet
}
/**
* @api
* @return int Index of the sheet, based on order of creation (zero-based)
*/
public function getIndex()
@@ -52,6 +53,7 @@ class Sheet
}
/**
* @api
* @return string Name of the sheet
*/
public function getName()
@@ -66,6 +68,7 @@ class Sheet
* - it should not contain these characters: \ / ? * : [ or ]
* - it should be unique
*
* @api
* @param string $name Name of the sheet
* @return Sheet
* @throws \Box\Spout\Writer\Exception\InvalidSheetNameException If the sheet's name is invalid.