Re[2]: [PEAR-CVS] cvs: pear /PHPDoc phpdoc
| From: | Hayk Chamyan | Date: | Fri, 21 Dec 2001 06:38:56 +0000 |
| Subject: | Re[2]: [PEAR-CVS] cvs: pear /PHPDoc phpdoc | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-3629@lists.php.net to get a copy of this message | ||
On Thursday, December 20, 2001, 13:21:24, Ulf Wendel wrote:
>> * Added the PHPDOC_ALLOWEDHTMLTAGS constant (html tags allowed in documentation).
UW> Cool, this was a often requested feature. Sorry for not implementing it
UW> on my own - I did not find the time to do so :/.
I have some questions about some of the current's PHPDoc features and
suggestions. Could you please spare some time to reply?
Questions:
1. In PHPDoc terms - module is a file containing functions and
constants. Can it contain variables? How do I need to document the
following code?
<?
$corban_counter = 0;
function corban_dear ()
{
global $corban_counter;
...
$corban_counter++;
...
}
?>
Unfortunately, now the module parser does not parse the variable
documentation. For this purpose I could add variable parsing. Please
comment.
2. PHPDoc returns a warning like '[function] fetch_result mismatch' -
'1st parameter type "$format" does not match the the documented type
"integer"...' for the following code:
<?php
define ("fmtRow", 0);
function fetch_result ($format=fmtRow)
{
...
}
?>
And also PHPDoc parses some constants incorrectly, e.g.:
<?php
define ("NBSP", " ");
define ("BOLDTEXT", "<b>" . NBSP . "%s" . NBSP .
"</b>");
?>
I'm confused. I don't know what I need to do.
Suggestions:
1. Maybe I should add some doc formatting meta-language (like BBCode or
Doxygen) for a better doc formatting to be also used by other renderers?
2. Maybe I should write a renderer for rendering documentation in other
formats (PDF for example)?
--
Sincerely yours,
Hayk
mailto:hayk@softerra.com
icq: 363611