makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-12 14:28:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/12715] Cleanup comments in \phpbb\extension\*

Browse source 
PHPBB3-12715
This commit is contained in:
Tristan Darricau 2014-06-15 13:31:17 +02:00
parent 1033da36a3
commit 047b709c47
3 changed files with 46 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
phpBB/phpbb/extension/manager.php
View file

@ -148,7 +148,7 @@ class manager
* Instantiates the metadata manager for the extension with the given name * Instantiates the metadata manager for the extension with the given name
* *
* @param string $name The extension 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 * @return \phpbb\extension\metadata_manager Instance of the metadata manager
*/ */
public function create_extension_metadata_manager($name, \phpbb\template\template $template) public function create_extension_metadata_manager($name, \phpbb\template\template $template)

5
phpBB/phpbb/extension/metadata_manager.php
View file

@ -138,7 +138,7 @@ class metadata_manager
/** /**
* Sets the filepath of the metadata file * 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() private function set_metadata_file()
{ {
@ -157,6 +157,7 @@ class metadata_manager
* Gets the contents of the composer.json file * Gets the contents of the composer.json file
* *
* @return bool True if success, throws an exception on failure * @return bool True if success, throws an exception on failure
* @throws \phpbb\extension\exception
*/ */
private function fetch_metadata() private function fetch_metadata()
{ {
@ -199,6 +200,7 @@ class metadata_manager
* "display" for name, type, and authors * "display" for name, type, and authors
* "name", "type") * "name", "type")
* @return Bool True if valid, throws an exception if invalid * @return Bool True if valid, throws an exception if invalid
* @throws \phpbb\extension\exception
*/ */
public function validate($name = 'display') public function validate($name = 'display')
{ {
@ -250,6 +252,7 @@ class metadata_manager
* Validates the contents of the authors field * Validates the contents of the authors field
* *
* @return boolean True when passes validation, throws exception if invalid * @return boolean True when passes validation, throws exception if invalid
* @throws \phpbb\extension\exception
*/ */
public function validate_authors() public function validate_authors()
{ {

2
phpBB/phpbb/extension/provider.php
View file

@ -58,7 +58,7 @@ abstract class provider implements \IteratorAggregate
/** /**
* Retrieve an iterator over all items * 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() public function getIterator()
{ {