CS: Fix phpdoc tags indent in Icinga/Application/Modules/Module.php

refs #4530
This commit is contained in:
Eric Lippmann 2013-08-14 10:43:57 +02:00
parent be29b8ff8f
commit 8c91410680

View File

@ -2,24 +2,24 @@
// {{{ICINGA_LICENSE_HEADER}}} // {{{ICINGA_LICENSE_HEADER}}}
/** /**
* This file is part of Icinga 2 Web. * This file is part of Icinga 2 Web.
* *
* Icinga 2 Web - Head for multiple monitoring backends. * Icinga 2 Web - Head for multiple monitoring backends.
* Copyright (C) 2013 Icinga Development Team * Copyright (C) 2013 Icinga Development Team
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2 * as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version. * of the License, or (at your option) any later version.
* *
* This program is distributed in the hope that it will be useful, * This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details. * GNU General Public License for more details.
* *
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software * along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* *
* @copyright 2013 Icinga Development Team <info@icinga.org> * @copyright 2013 Icinga Development Team <info@icinga.org>
* @license http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2 * @license http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
* @author Icinga Development Team <info@icinga.org> * @author Icinga Development Team <info@icinga.org>
@ -43,63 +43,54 @@ class Module
{ {
/** /**
* Module name * Module name
*
* @var string * @var string
*/ */
private $name; private $name;
/** /**
* Base directory of module * Base directory of module
*
* @var string * @var string
*/ */
private $basedir; private $basedir;
/** /**
* Directory for styles * Directory for styles
*
* @var string * @var string
*/ */
private $cssdir; private $cssdir;
/** /**
* Library directory * Library directory
*
* @var string * @var string
*/ */
private $libdir; private $libdir;
/** /**
* Directory containing translations * Directory containing translations
*
* @var string * @var string
*/ */
private $localedir; private $localedir;
/** /**
* Directory where controllers reside * Directory where controllers reside
*
* @var string * @var string
*/ */
private $controllerdir; private $controllerdir;
/** /**
* Directory containing form implementations * Directory containing form implementations
*
* @var string * @var string
*/ */
private $formdir; private $formdir;
/** /**
* Module bootstrapping script * Module bootstrapping script
*
* @var string * @var string
*/ */
private $registerscript; private $registerscript;
/** /**
* Icinga application * Icinga application
*
* @var \Icinga\Application\Web * @var \Icinga\Application\Web
*/ */
private $app; private $app;
@ -107,9 +98,9 @@ class Module
/** /**
* Create a new module object * Create a new module object
* *
* @param ApplicationBootstrap $app * @param ApplicationBootstrap $app
* @param string $name * @param string $name
* @param strinb $basedir * @param string $basedir
*/ */
public function __construct(ApplicationBootstrap $app, $name, $basedir) public function __construct(ApplicationBootstrap $app, $name, $basedir)
{ {
@ -141,8 +132,8 @@ class Module
/** /**
* Test for an enabled module by name * Test for an enabled module by name
* *
* @param string $name * @param string $name
* @return boolean * @return boolean
*/ */
public static function exists($name) public static function exists($name)
{ {
@ -152,9 +143,10 @@ class Module
/** /**
* Get module by name * Get module by name
* *
* @param string $name * @param string $name
* @param bool $autoload * @param bool $autoload
* @return mixed * @return mixed
* @throws \Icinga\Exception\ProgrammingError When the module is not yet loaded
*/ */
public static function get($name, $autoload = false) public static function get($name, $autoload = false)
{ {
@ -164,7 +156,7 @@ class Module
$manager->loadModule($name); $manager->loadModule($name);
} }
} }
// @throws ProgrammingError: // Throws ProgrammingError when the module is not yet loaded
return $manager->getModule($name); return $manager->getModule($name);
} }
@ -200,6 +192,7 @@ class Module
/** /**
* Getter for base directory * Getter for base directory
*
* @return string * @return string
*/ */
public function getBaseDir() public function getBaseDir()
@ -245,8 +238,8 @@ class Module
/** /**
* Getter for module config object * Getter for module config object
* *
* @param null|string $file * @param null|string $file
* @return Config * @return Config
*/ */
public function getConfig($file = null) public function getConfig($file = null)
{ {
@ -380,10 +373,10 @@ class Module
/** /**
* Register hook * Register hook
* *
* @param string $name * @param string $name
* @param string $class * @param string $class
* @param string $key * @param string $key
* @return self * @return self
*/ */
protected function registerHook($name, $key, $class) protected function registerHook($name, $key, $class)
{ {