views:

389

answers:

3

Okay, I'm fed up with phpDocumentator. It consumes way much more memory (1.4 GB) and time (5 minutes on 2.6GHz Core 2 Duo) than I'm willing to give it. Does there exist some really compatible program to generate documentation for PHP code?

I've tried PHPDoctor, which looks nice, but it has some missing features. However it is probably closest to be replacement from all solutions I've tried so far.

I've also tried PhpDocGen, but it just bails out with some Perl errors, which I'm too lazy to study.

Doxygen also does not seem to play well with our sources.

PS: The documentation would be for phpMyAdmin, a little bit outdated documentation is here.

Update: The code contains lot of functions and not only objects, what is the biggest problem with Doxygen, because it fails to organize them.

+1  A: 

I've been using Natural Docs, works well for me

Lauri
It might be good option, but it would mean converting all the documentation to new format, which is work I'd like to avoid.
Michal Čihař
+3  A: 

We switched from phpDocumentor to Doxygen because the former did not support PHP 5.3 features like namespaces and closures. phpDocumentor's last update was in 2008.

The major @-attributes are the same in Doxygen, because they both do JavaDoc-style comments. It is quite configurable, too.

janmoesen
I see several problems with Doxygen, but maybe I'm just unable to configure it properly. It does not handle file level comments and creates huge mess out of it in namespace documentation. It does not generate documentation for functions unless `EXTRACT_ALL` is enabled and it still does not provide some easy way to browse functions besides going through files. Also it does not support @uses and @subpackage.
Michal Čihař
We do not use `@subpackage` (that is what namespaces do now) or `@uses` (no use for it, hah). As for file level comments: that can indeed be a problem, but we follow the "one class per file" approach so we just use class comments.
janmoesen
Having just classes would make the things probably easier, but it is not the case (yet).
Michal Čihař
+2  A: 

Doxygen is pretty complex, and it's supposed to support PHP 5.3 features. However, it didn't work exactly how I wanted it and I realized it's a big program, but not designed for PHP; so I needed something lighter, simpler and preferably PHP exclusive, because let's face it, PHP does not have quite the common programming language syntax and look.

I know you mentioned it, but I chose PHPDoctor in the end. It does indeed lack some features, but it's simple and fast, exactly what I was looking for.

Let us know what you chose and what were the reasons.

Also something to mention is that I found the PHPDoctor interface to be quite simple and easy to style (with few CSS changes). I was able to create quite a clean page for my docs.

treznik