Re: PHPDoc problems

Ulf, Thanks for getting back to me. Overall, I have 3 questions. Question 1) When I run PHPDoc on a file containing the following, ********************************** <? /** * This function is being used as a test. * * @author Panteli Poulikakos * @param $test_param test parameter */ function test_function($test_param) { echo $test_param; } ?> ********************************** the PHPDoc output looks like the following: ********************************** Private Method Summary void test_function( $test_param) This function is being used as a test. Private Method Details test_function private void test_function( $test_param ) This function is being used as a test. Parameter $test_param Warning: documentation is missing. Returns void Author(s) ********************************** Even though I specified my name in the @author tag, my name is not showing up in the PHPDoc output. Is my syntax incorrect anywhere? Question 2) 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. 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. 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 PHP Notice Undefined index: filename file: phpdoc/analyser/PhpdocClassAnalyser.php line 163 PHP Notice Undefined index: undoc file: phpdoc/analyser/PhpdocClassAnalyser.php line 164 ********************************** Actually, multiple instances of the errors above and quite a few more different errors come up. Does the difference in version (4.0.1pl2 on the system without errors vs. 4.0.2 on the system with errors) make a difference? I would think that newer is better as far as versions, but in this case it doesn't seem to be the case. Let me know if you're aware of the issues I've described and if you could recommend any remedies, I would greatly appreciate it. Thanks in advance, Panteli Poulikakos --- Ulf Wendel <ulf.wendel@phpdoc.de> wrote: > > > 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 __________________________________________________ Do You Yahoo!? Yahoo! Shopping - Thousands of Stores. Millions of Products. http://shopping.yahoo.com/