ZF-7315: Review phpDoc for API documentation generation

Issue Type:
Bug
Created:
2009-07-20T02:39:02.000+0000
Last Updated:
2012-11-20T21:38:10.000+0000
Status:
Open
Fix version(s):
    Reporter:
    Mickael Perraud (mikaelkael)
    Assignee:
    None
    Tags:
    Related issues:
    Attachments:

    Description

    Review phpDoc for API documentation generation.

    Is the @const tag allowed?

    Is the contruction:

    
    /**#@+
     * Plugin loader type constants
     */
    const DECORATOR = 'DECORATOR';
    const ELEMENT = 'ELEMENT';
    /**#@-*/

    allowed? only for constant ?

    Comments

    Posted by Mickael Perraud (mikaelkael) on 2009-07-20T02:43:27.000+0000

    Made SVN16865 for Zend_Cache_Backend_ZendServer before opening this issue

    Posted by Matthew Weier O'Phinney (matthew) on 2009-07-20T05:01:51.000+0000

    @const is not a supported PhpDocumentor tag.

    Posted by Mickael Perraud (mikaelkael) on 2009-07-20T05:12:47.000+0000

    I know but there are some occurences (for example Zend_Dojo ;) ). Do we remove them? I didn't found the information in coding standards.

    Posted by Matthew Weier O'Phinney (matthew) on 2009-07-20T06:06:38.000+0000

    Yes -- we should remove them or replace them with @var.

    Posted by Martin de Keijzer (martin1982) on 2010-10-29T14:04:25.000+0000

    A quick search showed me that @const is still being used 25 times in 22 files. Should these be removed or renamed to @var? I also noticed that 2 occurrences in Zend_Translate_Adapter are defined as follows;

    

* @constant integer

    These occurrences are on lines 70 and 76