473,320 Members | 1,794 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,320 software developers and data experts.

phpDocumentor beta giving unexpected results

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.

Aug 4 '06 #1
2 1393
I've solved the categorization issue; seems to have stemmed from not
having proper page-level DocBlock, and following DocBlock assoc with
define-require-etc.
I've eliminated all the warnings and now files and classes are in
proper package-subPkg.

Still having problems getting the Fxs documented. So allow me to
ask...
Is Win CLI a valid way to run this ? (note versions, from prev. post)
The only Fx that did appear in RH frame of documentation, had DocBlock
with only tags.
Most of my Fxs have DocBlock with short desc, long desc, and tags

Is there a specific format that I should adhere to ?
Can the long desc have a blank line in the middle of it ? ( *
prepended, of course )
Can the @tags start on the lines immediately following ?
I notice heredoc assignments in my php file, will that throw things
off ?
Do functions require @package tags ?

Does phpdoc require type hints ?
I got some strange, inaccurate Doc's from the 1 that did get detailed
in the Doc.
~~~~~~~ Doc Output ~~~~~~~~
getCurrImplDate (line 27)
return: ImpliedYear
int getCurrImplDate ( $mo, int $mo )
int $mo
$mo

~~~~~~~ Code Reads ~~~~~~~~
/**
*
*
* @param int $mo
*
* @return int ImpliedYear
*/
function getCurrImplDate($mo) { .... }

~~~~~~~ End of Example ~~~~~~~~

Any help appreciated;
I'm looking forward to a resolution and successfully using phpDoc as a
great tool.

Aug 4 '06 #2
I am not familiar with a formal "Package" structure in PHP (unlike
Java) and I have loosely grouped by files, by conceptual functionality.
If more formal I may have to redo.
Perhaps phpdoc is tailored toward OO projects primarily. Only 1/4 of
my dev is OO.

Also, I am noticing a few more relevant warnings/errors in the Doc
Process Output
here regarding a customised Exception, of course with Parent class:
Exception

WARNING: class MyExc in package MyPackage parent not found in @see
parent::__construct()

finally
Fatal error: Call to undefined method ReflectionClass::hasMethod() in
C:\PHP\PEAR\PhpDocumentor\phpDocumentor\ParserElem ents.inc on line 1724

I'll just ask for assistance and resolution, not knowing enough about
this.
Hopefully I won't have to moan and lay in wait, all weekend LOL.

Aug 4 '06 #3

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

0
by: Jan van Mansum | last post by:
Hello group, I am trying to generate my API-documentation with PHPDocumentor (http://phpdocu.sourceforge.net/). It works nicely, only I don't understand the package-level documentation...
1
by: Oliver Grätz | last post by:
I am using phpDocumentor to generate documentation for my files. This worked without problems but today it told me "has no page-level DocBlock, use @package in the first DocBlock to create one" for...
0
by: alexander.stuckenholz | last post by:
Hello. I have two questions regarding the PHPDocumentor package: 1] Is it possible to add the html-output of phpdocumentor to existing output of the program? I have some pear packages and i'm...
0
by: Yarco | last post by:
I have just installed phpdocumentor on using: pear.bat install phpdocumentor-beta to suitable my php version. Then i create a test file "test.php" to have a trial. But the result is:...
2
by: Beenz | last post by:
Hello, I am developing an application in C#, which was previously in .Net 2005 Beta, then it was working perfectly fine, but from the time I have upgraded it to .Net 2.0 Professional, its...
2
by: Beenish Sahar Khan | last post by:
Hello, I am developing an application in C#, which was previously in .Net 2005 Beta, then it was working perfectly fine, but from the time I have upgraded it to .Net 2005 Professional, its...
2
by: mayankbpatel | last post by:
Has anyone gotten PhpDocumentor from http://www.phpdoc.org/ to work from the command line? I run it on the examples directory like it is described in the tutorial: phpdoc -t docs -f...
0
by: comp.lang.php | last post by:
I'm not having a good coding week. The following PHPDocumentor code displays wrong: /** * Class for alternatively handling sessions other than the {@link...
13
by: bintom | last post by:
I ran the following simple code in C++ and got unexpected results: float f = 139.4; cout << f; Output: 139.399994;
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
1
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.