|
|
Posted by awebguynow on 08/04/06 03:13
Overall, I'm pleased with phpDocumentor, but I've only been using it a
day, and I'm not getting exactly what I expected. I've read the FAQ,
Tutorial and Manual briefly.
I'm using WinXP
PHP Version 5.0.4
phpDocumentor version 1.3.0RC6
Many of my files and functions are not being documented right and are
not being categorized into the correct package.
At first I noticed it on the functions, and using the
HTML:frames:default the displayed Fx link was on the LH frame, but
clicking just showed a blank page on the RH frame. I wondered if
indentation was a problem, but I've tried both ways, and I'm not
getting any Fx descriptions from the DocBlocks and tags I've inserted.
The (mandatory?) page-level DocBlock with @package tag at top, seems
strongly suggested, so I've tried to comply. A following "require"
statement often gives error, so I've used a dummy DocBlock for that
separately, such as:
/**
* include require stuff
*/
I notice files that use a page-leve DocBlock with the same @package
and @subpackage tags, are not all being categorized correctly, some
falling into default package.
I used Pear to install phpDocumentor
>pear info pear
ABOUT PEAR-1.3.5
I'm using the command-line (CLI) to do this, but I'm not using
"php-cli" as the manual refers to it. That must be from earlier PHP
versions.
I also did not find, any easy to use .bat files or phpdoc.php or
new_phpdoc.*
I Did find: phpdoc.inc and it seems to be working OK
>php "C:\php\PhpDocumentor\phpDocumentor\phpdoc.inc" -d -i -t -o
obviously with the proper args for the corresponding switches.
I know this product is used widely and has alot of support. I'm
hoping, this buggy behavior is either something I've not realized, or
easily fixed with a suggestion. thanks.
Navigation:
[Reply to this message]
|