Any tutorials on how to use phpDocumentor?

php phpdoc
Polsonby picture Polsonby · Dec 2, 2009 · Viewed 7.7k times · Source

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:

  1. Pear wasn't working on my Mac so downloaded version 1.4.3 and unzipped it to a directory
  2. Specified the absolute path to sample file 2 on my HD under file tab
  3. Specified an output folder which was world writable
  4. 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.

Answer

phenry picture phenry · Nov 2, 2010

The documentation doesn't tell you this, but you have to move the sample files into a directory that doesn't have the string "tutorial" anywhere in the path. phpDocumentor treats "tutorial" as a reserved word and refuses to parse any files that have it in the path.

Related questions

PHPDoc type hinting for array of objects?

So, in PHPDoc one can specify @var above the member variable declaration to hint at its type. Then an IDE, for ex. PHPEd, will know what type of object it's working with and will be able to provide a code …

Read More
PHP Function Comments

Just a quick question: I've seen that some PHP functions are commented at the top, using a format that is unknown to me: /** * * Convert an object to an array * * @param object $object The object to convert * @return array * */ My IDE …

Read More
Best way to document Array options in PHPDoc?

I'm struggling to write readable and easy to understand documentation that describes the multi-tree structure for Array options that are passed to a function. Here is an example array structure. $arr = [ 'fields' => [ 'title' => [ 'name' => 'Document.title', 'format' =&…

Read More