Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Inline PHPDoc #3

Closed
mvriel opened this issue Aug 9, 2013 · 1 comment
Closed

Add Inline PHPDoc #3

mvriel opened this issue Aug 9, 2013 · 1 comment

Comments

@mvriel
Copy link
Member

mvriel commented Aug 9, 2013

From the current PSR:

Specific Tags MAY have an "Inline PHPDoc" section at the end of the "Tag"
definition. An "Inline PHPDoc" is a "PHPDoc" element enclosed in braces ({, }) and is present at the end of a "Tag" sequence unless specified otherwise in a
"Tag" definition, the "Inline PHPDoc" element MUST replace any description that
COULD have been provided.

An example can be the @method tag. This tag may be augmented using an
"Inline PHPDoc" to provide additional information regarding the parameters,
return value or any other tag supported by functions and methods.

Example

/**
 * @method integer MyMagicMethod(string $argument1) {
 *     This is the short description for MyMagicMethod.
 *
 *     @param string $argument1
 *
 *     @return integer
 * }
 */
 class MyMagicClass
 {
     ...
 }
mvriel pushed a commit that referenced this issue Oct 11, 2013
mvriel pushed a commit that referenced this issue Mar 25, 2014
Removed superfluous brackets
@mvriel mvriel closed this as completed in db15c21 Mar 25, 2014
@mvriel
Copy link
Member Author

mvriel commented Mar 25, 2014

Added descriptions for inline PHPDoc

mvriel pushed a commit that referenced this issue Dec 9, 2014
[Cache] Changing remove() to delete() as per Cache Survey Results
mindplay-dk pushed a commit to mindplay-dk/fig-standards that referenced this issue Nov 28, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant