Re: PHPDocumentor

Joel Allyn Cron wrote:

I find it rather funny that the Documentation for the Documentor is rather sparse about how to actually use the tool. The user interface on the web interface is mind boggling to a new user (me, for instance). I've been messing with it for a couple of hours and (embarassingly enough) I haven't gotten it to make docs for itself yet. http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using

This link might help a bit. PhpDocumentor is very well documented but it still might not have everything you since its focus is on howto write documentation not to use the tool, since its assumed most developers could figure it out. Anyhow anyone who wants to add a more indepth tutorial for those parts just needs to contact me and i'll add it in. The main things you need to do to make the docs for phpDocumentor are: Make phpDocumentor avialable to the web server (don't put it on a public web server) See if your getting hit by a bug that will prevent documentation generation if you see:

Fatal error: Cannot instantiate non-existent class: html_treenode in     /home/jeichorn/public_html/phpDocumentor-1.2.0/docbuilder/includes/utilities.php

on line 53 You are having the problem just add: include_once("../HTML_TreeMenu-1.1.2/TreeMenu.php" ); as the first line to docbuilder/includes/utilities.php Goto the Files tab Set the directory to parse to the location of phpDocumentor: in my case /home/jeichorn/public_html/phpDocumentor-1.2.0 Goto the Output Tab set the target to someplace the webserver can create files: in my case: /tmp/docs Set the Output format you want or just leave it to be the default (there is a bug here the output box should be multi-line) I picked HTML:Smarty:PHP Goto the Options Tab set the Generated Doumentation Title to: phpDocumentor Docs Hit the create button at the bottom of the page (if you hit the earlier error there will be no create button) Then you'll see a lot of output in the botton frame let it run until it stops spitting output. Then just browse your generated docs. Let me know if you need anything else, im asuming your hit that bug and thats what was creating the problems, i'll try to do a 1.2.1 release that has that bug fixed by the end of the week, i just have to figure out where the real fix should go (i don't code or use the web interface normally) -joshua eichorn phpDocumentor project admin phpdoc.org