mirror of
https://github.com/phpbb/phpbb.git
synced 2025-06-11 13:58:54 +00:00
[ticket/12715] Cleanup comments in \phpbb\extension\*
PHPBB3-12715
This commit is contained in:
parent
1033da36a3
commit
047b709c47
3 changed files with 46 additions and 43 deletions
|
@ -148,7 +148,7 @@ class manager
|
|||
* Instantiates the metadata manager for the extension with the given name
|
||||
*
|
||||
* @param string $name The extension name
|
||||
* @param string $template The template manager
|
||||
* @param \phpbb\template\template $template The template manager
|
||||
* @return \phpbb\extension\metadata_manager Instance of the metadata manager
|
||||
*/
|
||||
public function create_extension_metadata_manager($name, \phpbb\template\template $template)
|
||||
|
|
|
@ -138,7 +138,7 @@ class metadata_manager
|
|||
/**
|
||||
* Sets the filepath of the metadata file
|
||||
*
|
||||
* @return boolean Set to true if it exists, throws an exception on failure
|
||||
* @throws \phpbb\extension\exception
|
||||
*/
|
||||
private function set_metadata_file()
|
||||
{
|
||||
|
@ -157,6 +157,7 @@ class metadata_manager
|
|||
* Gets the contents of the composer.json file
|
||||
*
|
||||
* @return bool True if success, throws an exception on failure
|
||||
* @throws \phpbb\extension\exception
|
||||
*/
|
||||
private function fetch_metadata()
|
||||
{
|
||||
|
@ -199,6 +200,7 @@ class metadata_manager
|
|||
* "display" for name, type, and authors
|
||||
* "name", "type")
|
||||
* @return Bool True if valid, throws an exception if invalid
|
||||
* @throws \phpbb\extension\exception
|
||||
*/
|
||||
public function validate($name = 'display')
|
||||
{
|
||||
|
@ -250,6 +252,7 @@ class metadata_manager
|
|||
* Validates the contents of the authors field
|
||||
*
|
||||
* @return boolean True when passes validation, throws exception if invalid
|
||||
* @throws \phpbb\extension\exception
|
||||
*/
|
||||
public function validate_authors()
|
||||
{
|
||||
|
|
|
@ -58,7 +58,7 @@ abstract class provider implements \IteratorAggregate
|
|||
/**
|
||||
* Retrieve an iterator over all items
|
||||
*
|
||||
* @return ArrayIterator An iterator for the array of template paths
|
||||
* @return \ArrayIterator An iterator for the array of template paths
|
||||
*/
|
||||
public function getIterator()
|
||||
{
|
||||
|
|
Loading…
Add table
Reference in a new issue