Feature #38688

Create sniff for function / method doc comment long types

Added by Andy Grunwald about 3 years ago. Updated 11 months ago.

Status:Closed Start date:2012-07-05
Priority:Should have Due date:
Assigned To:- % Done:

0%

Category:Commenting
Target version:1.1.0
Branch:v4 Tags:

Description

In the cgl there is a doc block comment example

/**
 * Initializes the plugin.
 *
 * Checks the configuration and substitutes defaults for missing values.
 *
 * @param array $conf Plugin configuration from TypoScript
 * @return boolean TRUE if initialization was successful, FALSE otherwise 
 * @see tx_myext_class:anotherFunc()
 */
protected function initialize(array $conf) {
// Do something
}

In this example the long types are used (boolean instead of bool).

It must be discussed if the long types are mandatory or it if free to the developer.
Lets create a ticket at the cgl forge project. After this we can determine if there must be a sniff :)


Related issues

blocked by Coding Guidelines - Task #53113: Use short version of type names Resolved 2013-10-24

History

#1 Updated by Stefano Kowalke almost 3 years ago

  • Status changed from New to Accepted
  • Target version set to 0.0.5

#2 Updated by Stefano Kowalke almost 3 years ago

  • Target version changed from 0.0.5 to 0.0.6

#3 Updated by Stefano Kowalke over 2 years ago

  • Target version changed from 0.0.6 to 1.0.0

#4 Updated by Stefano Kowalke almost 2 years ago

  • Status changed from Accepted to On Hold

#5 Updated by Stefano Kowalke almost 2 years ago

  • Target version changed from 1.0.0 to 1.1.0

#6 Updated by Andy Grunwald 11 months ago

  • Status changed from On Hold to Closed

Also available in: Atom PDF