ZF-4297: [dojo path] improve documentation for setLocalPath method

Issue Type:
Docs: Improvement
Created:
2008-09-15T11:17:34.000+0000
Last Updated:
2011-08-28T10:17:56.000+0000
Status:
Open
Fix version(s):
    Reporter:
    Roy Ganor (royganor)
    Assignee:
    Matthew Weier O'Phinney (matthew)
    Tags:
    • Zend_Dojo
    Related issues:
    Attachments:

    Description

    Class- Zend_Dojo_View_Helper_Dojo_Container method: public function setLocalPath($path)

    current php doc block is: /** * Set path to local dojo * * @param string $path * @return Zend_Dojo_View_Helper_Dojo_Container */

    Since the word "path" can be used for files and folders - it is not clear if the user of this method should provide folder of dojo or dojo.js folder or dojo.js full path.

    I would expect something like "Set path to local dojo.js file" or something like this.

    Comments

    Posted by Robert Basic (robertbasic) on 2011-08-28T10:17:56.000+0000

    Docblock improvement.