FAQ
Edit report at http://pear.php.net/bugs/bug.php?id=14312&edit=1

ID: 14312
Updated by: demon.gene@gmail.com
Reported By: jo at feuersee dot de
Summary: @param tag with additional arguments doesn't work as
expected
-Status: Open
+Status: Assigned
Type: Documentation Problem
Package: PhpDocumentor
Operating System: Linux
Package Version: 1.4.2
PHP Version: 5.2.6
-Assigned To:
+Assigned To: ashnazg
-Roadmap Versions:
+Roadmap Versions: 1.4.3
New Comment:

-Status: Open
+Status: Assigned
-Assigned To:
+Assigned To: ashnazg
-Roadmap Versions:
+Roadmap Versions: 1.4.3




Previous Comments:
------------------------------------------------------------------------

[2008-07-26 09:38:42] doconnor

Doc problem or bug?

------------------------------------------------------------------------

[2008-07-08 16:00:00] panamajo

Description:
------------
I am using PhpDocumentor to generate HTML docs
(phpdoc ... -o HTML:Smarty:HandS).
The results do differ from the expected (in this case I am
referring to
<http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html>)

Maybe it's only a documentation problem. Best results when
documenting the source like this:

/**
* @param string $text ,... string to translate, optional
additional arguments
* @return string translation
*/
function i18n ($text)
...

NOTE: there is a blank between $text and ,...


Test script:
---------------
/**
* @param string $text string to translate
* @param string $text,... optional additional arguments
* @return string translation
*/
function i18n ($text)
{
return(foo($text));
}



Expected result:
----------------
The documentation should display the function prototype like
this:
string i18n( string $text,... )


Actual result:
--------------
string i18n( string $text, string $text,... )

Note that this implies that at least 2 params are mandatory
which is totally wrong.

------------------------------------------------------------------------

Search Discussions

  • Demon Gene at Jun 1, 2009 at 9:30 pm
    Edit report at http://pear.php.net/bugs/bug.php?id=14312&edit=1

    ID: 14312
    Updated by: demon.gene@gmail.com
    Reported By: jo at feuersee dot de
    Summary: @param tag with additional arguments doesn't work as
    expected
    -Status: Assigned
    +Status: Closed
    Type: Documentation Problem
    Package: PhpDocumentor
    Operating System: Linux
    Package Version: 1.4.2
    PHP Version: 5.2.6
    Assigned To: ashnazg
    Roadmap Versions:
    New Comment:

    -Status: Assigned
    +Status: Closed

    Added verbiage to the PARAM docs to clarify usage of the
    "$paramname,..." syntax.


    Previous Comments:
    ------------------------------------------------------------------------

    [2009-06-01 23:28:25] ashnazg

    -Status: Open
    +Status: Assigned
    -Assigned To:
    +Assigned To: ashnazg
    -Roadmap Versions:
    +Roadmap Versions: 1.4.3


    ------------------------------------------------------------------------

    [2008-07-26 09:38:42] doconnor

    Doc problem or bug?

    ------------------------------------------------------------------------

    [2008-07-08 16:00:00] panamajo

    Description:
    ------------
    I am using PhpDocumentor to generate HTML docs
    (phpdoc ... -o HTML:Smarty:HandS).
    The results do differ from the expected (in this case I am
    referring to
    <http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html>)

    Maybe it's only a documentation problem. Best results when
    documenting the source like this:

    /**
    * @param string $text ,... string to translate, optional
    additional arguments
    * @return string translation
    */
    function i18n ($text)
    ...

    NOTE: there is a blank between $text and ,...


    Test script:
    ---------------
    /**
    * @param string $text string to translate
    * @param string $text,... optional additional arguments
    * @return string translation
    */
    function i18n ($text)
    {
    return(foo($text));
    }



    Expected result:
    ----------------
    The documentation should display the function prototype like
    this:
    string i18n( string $text,... )


    Actual result:
    --------------
    string i18n( string $text, string $text,... )

    Note that this implies that at least 2 params are mandatory
    which is totally wrong.

    ------------------------------------------------------------------------
  • Demon Gene at Jun 1, 2009 at 9:30 pm
    Edit report at http://pear.php.net/bugs/bug.php?id=14312&edit=1

    ID: 14312
    Updated by: demon.gene@gmail.com
    Reported By: jo at feuersee dot de
    Summary: @param tag with additional arguments doesn't work as
    expected
    Status: Closed
    Type: Documentation Problem
    Package: PhpDocumentor
    Operating System: Linux
    Package Version: 1.4.2
    PHP Version: 5.2.6
    Assigned To: ashnazg
    Roadmap Versions:
    New Comment:

    Changes committed to CVS. Look for the manual to be updated with the
    release of v1.4.3.


    Previous Comments:
    ------------------------------------------------------------------------

    [2009-06-01 23:29:05] ashnazg

    -Status: Assigned
    +Status: Closed

    Added verbiage to the PARAM docs to clarify usage of the
    "$paramname,..." syntax.

    ------------------------------------------------------------------------

    [2009-06-01 23:28:25] ashnazg

    -Status: Open
    +Status: Assigned
    -Assigned To:
    +Assigned To: ashnazg
    -Roadmap Versions:
    +Roadmap Versions: 1.4.3


    ------------------------------------------------------------------------

    [2008-07-26 09:38:42] doconnor

    Doc problem or bug?

    ------------------------------------------------------------------------

    [2008-07-08 16:00:00] panamajo

    Description:
    ------------
    I am using PhpDocumentor to generate HTML docs
    (phpdoc ... -o HTML:Smarty:HandS).
    The results do differ from the expected (in this case I am
    referring to
    <http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html>)

    Maybe it's only a documentation problem. Best results when
    documenting the source like this:

    /**
    * @param string $text ,... string to translate, optional
    additional arguments
    * @return string translation
    */
    function i18n ($text)
    ...

    NOTE: there is a blank between $text and ,...


    Test script:
    ---------------
    /**
    * @param string $text string to translate
    * @param string $text,... optional additional arguments
    * @return string translation
    */
    function i18n ($text)
    {
    return(foo($text));
    }



    Expected result:
    ----------------
    The documentation should display the function prototype like
    this:
    string i18n( string $text,... )


    Actual result:
    --------------
    string i18n( string $text, string $text,... )

    Note that this implies that at least 2 params are mandatory
    which is totally wrong.

    ------------------------------------------------------------------------

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
grouppear-bugs @
categoriesphp
postedJun 1, '09 at 9:29p
activeJun 1, '09 at 9:30p
posts3
users1
websitepear.php.net

1 user in discussion

Demon Gene: 3 posts

People

Translate

site design / logo © 2021 Grokbase