Modules\Module: clean up phpdoc blocks

This commit is contained in:
Thomas Gelf 2014-05-26 14:14:34 +00:00
parent 5b87d6238b
commit 7c68d0a30f

View File

@ -217,7 +217,7 @@ class Module
*
* @return mixed
*
* @throws \Icinga\Exception\ProgrammingError When the module is not yet loaded
* @throws ProgrammingError When the module is not yet loaded
*/
public static function get($name, $autoload = false)
{
@ -429,6 +429,11 @@ class Module
return $this->basedir;
}
/**
* Get the controller directory
*
* @return string
*/
public function getControllerDir()
{
return $this->controllerdir;
@ -473,15 +478,14 @@ class Module
*/
public function getConfig($file = null)
{
return $this->app
->getConfig()
->module($this->name, $file);
return $this->app->getConfig()->module($this->name, $file);
}
/**
* Retrieve provided permissions
*
* @param string $name Permission name
*
* @return array
*/
public function getProvidedPermissions()
@ -506,6 +510,7 @@ class Module
* Whether the given permission name is supported
*
* @param string $name Permission name
*
* @return bool
*/
public function providesPermission($name)
@ -518,6 +523,7 @@ class Module
* Whether the given restriction name is supported
*
* @param string $name Restriction name
*
* @return bool
*/
public function providesRestriction($name)
@ -531,6 +537,7 @@ class Module
*
* @param string $name Unique permission name
* @param string $name Permission description
*
* @return void
*/
protected function providePermission($name, $description)
@ -550,7 +557,8 @@ class Module
* Provide a named restriction
*
* @param string $name Unique restriction name
* @param string $name Restriction description
* @param string $description Restriction description
*
* @return void
*/
protected function provideRestriction($name, $description)