Could anyone run the MODx API (/manager/includes/document.parser.class.inc.php) through PHPDocumentor for the community? I can’t seem to get it to work quite right on my server or on my command line. Thanks in advance.
Chanh, that’s cool, but with phpDoc, I believe you can control the output for the description and etc.
So which one that we’re going to use?
-
MODX Staff
- 10,725 Posts
I’ve got PHPDocumentor integrated with the Tattoo codebase already, and yes it does require special comment formatting and tags to work properly. Someone would need to go edit all the code with the proper code format. Not very practical I don’t think, but an effort that could be undertaken by someone with enough motivation none-the-less.
phpxref support phpdoc format standard and the great thing about phpxref it does not take down the machine just to create the doc unlike phpdoc or phpdocumentator.
Doxygen is a good project, very efficient. I used it few years ago.
The only thing which I have to reproach it, it is its configuration. I don’t find it very easy.
Personnally, I used PHPEdit to create websites and to generate the documentation. But PHPEdit use PHPdocumentator...
Sorry for my english. I'm french... My dictionary is near me, but it's only a dictionary !
-
MODX Staff
- 10,725 Posts
Part of the new 1.0 core code will include a build system that include automatic generation of API documentation (and internal developer documentation) via PHPDocumentor. It’s the only acceptable API doc generator I’ve found for automating the process from a build script (using Phing), and it seems to do a great job of it. I’m using this already in the development of MODx 1.0 and a separate object-relational bridge project I’m working on that will power the core of this new MODx. I’ll make some previews of this documentation available soon.
Only good news today
Sorry for my english. I'm french... My dictionary is near me, but it's only a dictionary !