Re: PHPDoc problems
| From: | Ulf Wendel | Date: | Wed, 13 Dec 2000 20:30:12 +0000 |
| Subject: | Re: PHPDoc problems | ||
| References: | 1 | Groups: | php.pear |
| Request: | Send a blank email to php-pear+get-684@lists.php.net to get a copy of this message | ||
Panteli Poulikakos wrote:
> I recently downloaded the latest version of PHPDoc
> (version 1.0beta) and have been trying to get it to
Well done, ... To be honest it's no more the original version but a
snapshot.
> work properly with doc comments I have in various PHP
> classes and modules. I'm running Linux and the
> LINEBREAK character is I believe "\n". So I changed
> the LINEBREAK define in PHPDoc's index.php to be "\n".
> In addition, I've modified the file in the PHPDoc's
> parser/ subdirectory so that $PHP_SELF["break"] =
> LINEBREAK instead of what was there before.
You mean $PHP_BASE["break"] in parser/PhpdocParserRegExp.php.
> Despite these changes, PHPDoc's output is not properly
> wrapping the comment lines for each doc comment. It
> is however distinguishing between the various class
> variables, class methods, functions, function
Can't really imagine what it looks like. Can you give me an example?
> parameters, etc. and listing them. Also, while my doc
> comments have @author tags in them, the PHPDoc output
> leaves the Author(s) field blank. I tried putting
This is strange indeed, in case you used the @author tag following to
the syntax @author Name1 Name1 [email@example.com] [, Name1 Name1
[email@example.com]]. Send me a code snippet via PM to debug it.
> HTML tags within the comments and this resulted in the
> raw HTML being printed out in the PHPDoc output files
> -- therefore it was not interpreted by the browser.
This is configurable. I don't like lots of HTML in Doc Comments. Change
renderer/html/PhpdocHTMLRenderer.php -> encode().
Ulf