Smaller fixes in phpdoc style

refs #4566
This commit is contained in:
Jannis Moßhammer 2013-08-28 14:42:31 +02:00
parent 7fab739efd
commit 4527aaf57a
5 changed files with 11 additions and 9 deletions

View File

@ -297,9 +297,9 @@ abstract class Form extends Zend_Form
* *
* Enables automatic submission of this form once the user edits specific elements * Enables automatic submission of this form once the user edits specific elements
* *
* @param array $triggerElements The element names which should auto-submit the form * @param array $triggerElements The element names which should auto-submit the form
* *
* @throws ProgrammingError When an element is found which does not yet exist * @throws ProgrammingError When an element is found which does not yet exist
*/ */
final public function enableAutoSubmit($triggerElements) final public function enableAutoSubmit($triggerElements)
{ {
@ -355,7 +355,7 @@ abstract class Form extends Zend_Form
* *
* This method should be used for testing purposes only * This method should be used for testing purposes only
* *
* @param bool $disabled * @param bool $disabled Set true in order to disable CSRF tokens in this form (default: true), otherwise false
* *
* @see tokenDisabled * @see tokenDisabled
*/ */
@ -388,9 +388,9 @@ abstract class Form extends Zend_Form
/** /**
* Test the submitted data for a correct CSRF token * Test the submitted data for a correct CSRF token
* *
* @param array $checkData The POST data send by the user * @param array $checkData The POST data send by the user
* *
* @throws InvalidCSRFTokenException When CSRF Validation fails * @throws InvalidCSRFTokenException When CSRF Validation fails
*/ */
final public function assertValidCsrfToken(array $checkData) final public function assertValidCsrfToken(array $checkData)
{ {

View File

@ -38,6 +38,7 @@ class CommandForm extends Form
{ {
/** /**
* Create an instance name containing hidden field * Create an instance name containing hidden field
*
* @return Zend_Form_Element_Hidden * @return Zend_Form_Element_Hidden
*/ */
private function createInstanceHiddenField() private function createInstanceHiddenField()
@ -60,7 +61,8 @@ class CommandForm extends Form
/** /**
* Get the author name * Get the author name
*
* @return string
*/ */
protected function getAuthorName() protected function getAuthorName()
{ {

View File

@ -99,7 +99,7 @@ class CustomNotificationForm extends CommandForm
/** /**
* Create Custom Notification from request data * Create Custom Notification from request data
* *
* @return \Icinga\Protocol\Commandpipe\CustomNotification * @return CustomNotification
*/ */
public function getCustomNotification() public function getCustomNotification()
{ {

View File

@ -258,8 +258,9 @@ class ScheduleDowntimeForm extends WithChildrenCommandForm
/** /**
* Change validators at runtime * Change validators at runtime
* *
* @param array $data The user provided data that will go into validation
*
* @see Form::preValidation * @see Form::preValidation
* @param array $data
*/ */
protected function preValidation(array $data) protected function preValidation(array $data)
{ {

View File

@ -83,7 +83,6 @@ class EditBackendForm extends Form
/** /**
* Set a custom array of resources to be used in this form instead of the ones from DbAdapterFactory * Set a custom array of resources to be used in this form instead of the ones from DbAdapterFactory
* (used for testing) * (used for testing)
*
*/ */
public function setResources($resources) public function setResources($resources)
{ {