doxygen | cvsmonitor | site news | drupal news | contact
Home » categories » drupal

should drupal use /** ... */ Doc Comments consistently to allow for automatic generation of API docs?

By ax 2003 Jun 15 - 22:20
add new comment | 1261 reads

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.

Doxygen is fine

I don't insist that the /** ... */ style of doxygen be used, but doxygen should be used consistently. I'll vote for yes, because it's close enough to my thoughts on the topic.

By anonymous at 2004, May 16 - 21:44 | reply

some background

here, here, and here

(why don't allow polls to have some introducing text?!)

By ax at 2003, June 15 - 22:33 | reply

Doxygen looks even better

Phpdoc would be good for Drupal. Any kind of code documentation for Drupal would be good, since at this point, there is next to none. But thanks to your site here, I've become interested in Doxygen. It looks even better than Phpdoc. I would suggest Drupal use Doxygen.

By anonymous at 2003, June 20 - 05:13 | reply

just the looks

phpDoc(umentor) and Doxygen use the same code base and the same DocBlocks to generate the docs you see here. that's what the vote actually refers to. maybe i should rephrase it to "Should drupal code be documented using PHPDoc compatible DocBlocks that allow for automatic generation of API docs"? or something like that?

mind to vote for it anyway? still wanting to convince Dries ... and maybe give away who you are?

i like the Doxygen generated doc better, too. the "References" and "Referenced by" for functions and the INLINE_SOURCES (inclusion of function bodies directly into the documentation) are just kick-ass.

By ax at 2003, June 20 - 13:40 | reply