Zend Framework

method docblocks contain invalid @param syntax

Details

  • Type: Bug Bug
  • Status: Resolved Resolved
  • Priority: Trivial Trivial
  • Resolution: Fixed
  • Affects Version/s: 1.11.1
  • Fix Version/s: 1.11.3
  • Component/s: None
  • Labels:
    None

Description

According to phpDocumentor, the correct format of @param is:

@param datatype $paramname description

There are some instances in the codebase where the datatype is omitted or the terms are out of order (i.e. @param $foo string)

For example, run this in the library dir:

find . -name '*.php' -print0 | xargs -0 grep -P '@param[ ]+\$'

The main side effect is that IDEs are generally be unable to do correct code completion/hinting for these methods.

Activity

Hide
Phoenix Zerin added a comment -

I'll start working on this. 76 files are affected as of r23578.

Show
Phoenix Zerin added a comment - I'll start working on this. 76 files are affected as of r23578.
Hide
Phoenix Zerin added a comment -

Patch for bin, demos, library and tests attached.

Show
Phoenix Zerin added a comment - Patch for bin, demos, library and tests attached.
Hide
Thomas Weidner added a comment -

Reopening issues
Please don't resolve issues as fixed without doing a commit

Show
Thomas Weidner added a comment - Reopening issues Please don't resolve issues as fixed without doing a commit
Hide
Mickael Perraud added a comment -

Patch applied with r23650. Thanks.

Show
Mickael Perraud added a comment - Patch applied with r23650. Thanks.
Hide
Thomas Weidner added a comment -

Fixed with GH-99 on ZF2

Show
Thomas Weidner added a comment - Fixed with GH-99 on ZF2

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved:

Time Tracking

Estimated:
Not Specified
Original Estimate - Not Specified
Remaining:
0m
Remaining Estimate - 0 minutes
Logged:
1h
Time Spent - 1 hour