MonitoringWizard: Fix documentation
This commit is contained in:
parent
ac78661943
commit
d69ab427a6
|
@ -25,7 +25,7 @@ use Icinga\Module\Setup\Requirement\PhpModuleRequirement;
|
|||
class MonitoringWizard extends Wizard implements SetupWizard
|
||||
{
|
||||
/**
|
||||
* @see Wizard::init()
|
||||
* Register all pages for this wizard
|
||||
*/
|
||||
public function init()
|
||||
{
|
||||
|
@ -39,7 +39,10 @@ class MonitoringWizard extends Wizard implements SetupWizard
|
|||
}
|
||||
|
||||
/**
|
||||
* @see Wizard::setupPage()
|
||||
* Setup the given page that is either going to be displayed or validated
|
||||
*
|
||||
* @param Form $page The page to setup
|
||||
* @param Request $request The current request
|
||||
*/
|
||||
public function setupPage(Form $page, Request $request)
|
||||
{
|
||||
|
@ -66,7 +69,16 @@ class MonitoringWizard extends Wizard implements SetupWizard
|
|||
}
|
||||
|
||||
/**
|
||||
* @see Wizard::getNewPage()
|
||||
* Return the new page to set as current page
|
||||
*
|
||||
* {@inheritdoc} Runs additional checks related to some registered pages.
|
||||
*
|
||||
* @param string $requestedPage The name of the requested page
|
||||
* @param Form $originPage The origin page
|
||||
*
|
||||
* @return Form The new page
|
||||
*
|
||||
* @throws InvalidArgumentException In case the requested page does not exist or is not permitted yet
|
||||
*/
|
||||
protected function getNewPage($requestedPage, Form $originPage)
|
||||
{
|
||||
|
@ -84,7 +96,9 @@ class MonitoringWizard extends Wizard implements SetupWizard
|
|||
}
|
||||
|
||||
/**
|
||||
* @see Wizard::addButtons()
|
||||
* Add buttons to the given page based on its position in the page-chain
|
||||
*
|
||||
* @param Form $page The page to add the buttons to
|
||||
*/
|
||||
protected function addButtons(Form $page)
|
||||
{
|
||||
|
@ -103,7 +117,9 @@ class MonitoringWizard extends Wizard implements SetupWizard
|
|||
}
|
||||
|
||||
/**
|
||||
* @see SetupWizard::getSetup()
|
||||
* Return the setup for this wizard
|
||||
*
|
||||
* @return Setup
|
||||
*/
|
||||
public function getSetup()
|
||||
{
|
||||
|
@ -135,7 +151,9 @@ class MonitoringWizard extends Wizard implements SetupWizard
|
|||
}
|
||||
|
||||
/**
|
||||
* @see SetupWizard::getRequirements()
|
||||
* Return the requirements of this wizard
|
||||
*
|
||||
* @return RequirementSet
|
||||
*/
|
||||
public function getRequirements()
|
||||
{
|
||||
|
|
Loading…
Reference in New Issue