Re: PHPDoc problems
| From: | Ulf Wendel | Date: | Fri, 15 Dec 2000 11:36:31 +0000 |
| Subject: | Re: PHPDoc problems | ||
| References: | 1 | Groups: | php.pear |
| Request: | Send a blank email to php-pear+get-699@lists.php.net to get a copy of this message | ||
Panteli Poulikakos schrieb:
> /**
> * This function is being used as a test.
> *
> * @author Panteli Poulikakos
Perfect, there must be an @author bug. I'll try to fix it after the
weekend.
> * @param $test_param test parameter
@param string [$test_param] description
The variable name is optional, but the variable type must be present.
> Parameter
> $test_param
> Warning: documentation is missing.
Probably wrong due to the wrong syntax.
> Returns void
Ok, not overriden default setting.
> Author(s)
> **********************************
Bug :(
> What are the various possibilities of what the
> PHPDOC_LINEBREAK should be defined to? I'm running a
> Linux based system and I'm not sure if the default
> setting of "\r\n" is affecting the problems I'm
> having.
Hmm, on my solaris box I use the following.
(from: parser/PhodocParserRegExp.php)
var $PHP_BASE = array (
"space" => "\s+",
"space_optional"=> "\s*",
"break" => "[\n\r]",
(from: index.php)
define("LINEBREAK", "\r\n");
On Unix the linebreak should be "\n". On Macintosh "\r" and on Windows
"\r\n". I'm not sure what's the reason why the above setting works for
me. I would habe to track it in detail. Do your XML files look good?
Anyway, it might be a good idea to write a simple installation wizard
that uses ord()/chr() to determine the system setting.
> Question 3)
> I have a library consisting of about 20 PHP files and
> when I run PHPDoc on a Windows98 system running Apache
> w/ PHP version 4.0.1pl2, PHPDoc executes and after
> about 60 seconds or so (I set max execution time in
> php.ini to 480), it displays the following:
>
> **********************************
> Parser starts...
> ... preparse to find modulegroups and classtrees.
> ... parsing classes.
> ... parsing modules.
> ... writing packagelist.
> Parser finished.
> Starting to render...
> **********************************
>
> And, no errors are displayed.
Are there any XML files?
> On a different system - Linux box running Apache w/
> PHP version 4.0.2, when I run PHPDoc on the same exact
> set of library files, I get the following:
>
> **********************************
> Parser starts...
> ... preparse to find modulegroups and classtrees.
> ... parsing classes.
>
> PHP Notice
> Undefined index: params
> file: phpdoc/analyser/PhpdocClassAnalyser.php line 197
These are simple warnings. Set down the error reporting level in your
php.ini. Warnings do not influence the work of PHPDoc although they're
not very beautiful and one fine day they might disappear.
Ulf
--
Ulf Wendel, NetUSE AG Siemenswall, D-24107 Kiel
Tel: +49 431 386 436 00, Fax: +49 431 386 435 99