Any tutorials on how to use phpDocumentor?

tags:

php
phpdoc

views:

667

answers:

+12 Q:

Any tutorials on how to use phpDocumentor?

Hello Stackers...

I want to start using phpDocumentor but I'm finding it hard going - the web interface is not playing nicely and I can't get it to parse the example files

I probably haven't set it up right and I would like a nice step-by-step tutorial (i.e. NOT THIS ONE) to check where I've gone wrong and hopefully get it parsing something

But I can't find anything via google - can anyone suggest any good tutorials or resources for getting started with phpdoc?

Many thanks!

Ian

EDIT: Thanks for jumping in, ashnazg! These were the steps I followed:

Pear wasn't working on my Mac so downloaded version 1.4.3 and unzipped it to a directory
Specified the absolute path to sample file 2 on my HD under file tab
Specified an output folder which was world writable
Clicked Create... stuff going on in log, media folder created but no report. Log concludes "ERROR: nothing parsed"

I since got Pear working and installed phpdoc that way; can use it through the command line, but any ideas about what could be up with the web interface to prevent it from parsing the file? Seems to be happy in all other respects.

EDIT 2: Thanks for the link to the Developer.com article, Liz: It's very basic but a useful quickstart.

Google is your friend :)

here's one: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial%5FphpDocumentor.howto.pkg.html

Liz Albin 2009-12-02 16:40:40

That's really extraordinarily unhelpful - if you read the question I asked, that's the same one I linked to. The point is that the instructions there don't work for me and I asked for OTHER tutorials.

Flubba 2009-12-03 08:28:34

You're correct, I gave you the wrong answer.Does this help? http://www.developer.com/lang/php/article.php/10941_3440261_2/Documenting-PHP-Code-with-PHPDocumentor.htm

Liz Albin 2009-12-03 14:02:58

Thanks for that; yes I found that using Google too :) But it is quite a good one.

Flubba 2009-12-03 14:30:06

I'm not aware of any such tutorials regarding using the web interface. I don't actually get that many questions for support using it. If you can highlight how you're using it without success, I might can help.

ashnazg 2009-12-03 11:42:37

Thanks for that - added some explanation to my post above

Flubba 2009-12-03 14:31:19

"ERROR: nothing parsed" indicates that phpDocumentor doesn't think you've given it any PHP files to process. Take a closer look at the runtime output, and see if you spot where it tries to use the absolute path you gave it. My first hunch might be it contains a folder with a space in its name... that _might_ be causing an issue.

ashnazg 2009-12-07 22:30:41

Personally, I use JavaDoc standard tags and a small Python program to convert my PHP into Java files (with empty method bodies). Then I run JavaDoc -- I like the features and looks of it much better than anything else I've seen. Well, I did start with java before PHP.

This little python program is part of my PHP stuff and can be found on

http://code.google.com/p/mcrwebapp/source/browse/trunk/tools/php2java

(for what it's worth.)

Don 2009-12-07 05:29:25

Very interesting Don, JavaDoc has always been my favorite. Not that it would be a huge task, but would you mind sharing your Python program to convert the PHP into a Java skeleton?

Dustin Fineout 2010-01-12 18:46:36

use one of htags opengrok http://linux.wareseeker.com/Programming/php-tag-engine-1.0.zip/327927 doxygen

Funsuk Wangadu 2010-01-17 08:05:37

+1 A:

You can visit the following Links to find out the Best PHP Documentor Tutorials I hope this will help you.

Tutorial Package

Quick Start Guide

An in-depth look at using phpDocumentor to document PHP Source Code, and phpDocumentor internals

Sanju 2010-01-19 07:47:58

How about the docs at it's home on pear: http://pear.php.net/manual/en/package.php.phpdocumentor.intro.php

bhazzard 2010-01-19 15:08:18