aC forum: PMF & C Documentation

Post #4 by apidevlab

apidevlab — Tue, 27 Mar 2007 21:11:58 UTC

As I have just started to use PHPEdit nd I wanted to put it through it's paces.

I agree with your comments regarding generators.

Still it's my way of passing something back to aC community and project.

It's also an excellent way to learn more about the code.

Post #3 by boxfan

boxfan — Tue, 27 Mar 2007 13:59:42 UTC

Thanks apidevlab...very helpful

Post #2 by Ilija Studen

Ilija Studen — Tue, 27 Mar 2007 10:51:52 UTC

Thanks. Generator has some small problems but still it looks a way better than something generated with phpDocumentor (anyone ever tried to work with phpDoc templates?)

A small offtopic:

How much do you really use API doc in PHP? I'm really sad to see that most API docs for PHP are garbage because generator developers focus on displaying every little thing that they can extract from code and miss the important stuff (or it gets lost in clutter).

I use API docs only on PEAR to see if package match my needs, nothing more. If I really need to see how stuff is working I'll dig through code and let Zend Studio guide me around (auto completion, go to resource and other nice ZS features help a lot).

Post #1 by apidevlab

apidevlab — Tue, 27 Mar 2007 00:48:14 UTC

Hi,
I have used PHPEdit to create a set of Properties, Methods, Fuctions and Classes documentation for the current 0.7.1 release.

This will hopefully be of some use to developer types and those aC users who would like to delve little deeper into the code.

As I have not been here for a while I am not sure of the best way to get in touch so will e-mail you these, they are created in PHPEdit so are free to distribute.

I was thinking of possibly creating a SF project for some docs/hacks/info and as a way to track development whilst providing an additional resource for users, but I a happy to take your lead on this.

Hope they are of some use to this excellent project.

UPDATE: You can get it from http://api.devlab.googlepages.com/activecollab