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

ID: 14305
Updated by: demon.gene@gmail.com
Reported By: pear at laurent-laville dot org
Summary: Missing/incomplete result for XML DocBook renderer
and @return tag
-Status: Verified
+Status: Wont fix
Type: Bug
Package: PhpDocumentor
Package Version: 1.4.2
PHP Version: 5.2.6
-Assigned To:
+Assigned To: ashnazg
-Roadmap Versions: 1.4.5
+Roadmap Versions:
New Comment:

-Status: Verified
+Status: Wont fix
-Assigned To:
+Assigned To: ashnazg
-Roadmap Versions: 1.4.5
+Roadmap Versions:
No more feature work on phpDocumentor 1.x. Check out the new
phpDocumentor 2.x (http://www.phpdoc.org/).


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

[2011-11-30 22:29:42] ashnazg

-Roadmap Versions: 1.4.4
+Roadmap Versions: 1.4.5


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

[2009-10-12 15:46:51] ashnazg

-Status: Open
+Status: Verified
Verified this behavior using this test case:

<?php
/**
* @package bug-14305
*/

/**
* @package bug-14305
*/
class Foo {
/**
* @return int
*/
public function bar() {}

/**
* @return float here's a description
*/
public function baz() {}
}
?>


No refsect1 is generated for bar()'s @return tag, while only the @return
tag's description, without a datatype, is shown in baz()'s refsect1.

This actually implies to me that the XML:DocBook/peardoc2:default output
converter is written to NOT include the return's datatype at all.
Therefore, the return info would only be generated if the return tag
contained a description.

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

[2009-07-21 17:34:36] ashnazg

-Roadmap Versions:
+Roadmap Versions: 1.4.3


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

[2008-07-07 17:34:07] farell

Description:
------------
With a source with only @return phpdoc tag + variable type, and XML
DocBook converter, the @return tag is not rendered !

Example 1:
* @return array

In this example, no return bloc rendered

Example 2:
* @return array or false on error

In this example the "array" term is not rendered


Expected result:
----------------
Example 1:

<refsect1
id="package.php.php-compatinfo.php-compatinfo-parser.getdirlist.returns">
&title.returns;
<para>
<emphasis>returns</emphasis>
array
</para>
</refsect1>

Example 2:

<refsect1
id="package.php.php-compatinfo.php-compatinfo-parser.getignoredfiles.returns">
&title.returns;
<para>
<emphasis>returns</emphasis>
array or false on error
</para>
</refsect1>

Actual result:
--------------
Example 1:

no refsect1 corresponding to &title.returns; was produced

Example 2:

<refsect1
id="package.php.php-compatinfo.php-compatinfo-parser.getignoredfiles.returns">
&title.returns;
<para>
<emphasis>returns</emphasis>
or false on error
</para>
</refsect1>

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

Search Discussions

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
grouppear-bugs @
categoriesphp
postedAug 31, '12 at 9:34p
activeAug 31, '12 at 9:34p
posts1
users1
websitepear.php.net

1 user in discussion

Demon Gene: 1 post

People

Translate

site design / logo © 2022 Grokbase