Brion Vibber wrote: Hello, r13740 migrated trunk from phpdoc to doxygen, I even updated the mwdocgen.php. The default configuration template only generates HTML output (in the same directory). cheers, -- Ashar Voultoiz - WP++++ http://en.wikipedia.org/wiki/User:Hashar http://www.livejournal.com/community/wikitech/ IM: hashar(a)jabber.org ICQ: 15325080

Ashar Voultoiz wrote: Neat! Now being autogenerated daily at http://svn.wikimedia.org/doc/ -- brion vibber (brion @ pobox.com)

On 19/04/06, Tels <nospam-abuse(a)bloodgate.com> wrote: As Avar said in a previous message; the documentation is limited in terms of the original code; if the comments to document it were not there, then the generated documentation will be sparse. Rob Church

On 4/19/06, Rob Church <robchur(a)gmail.com> wrote: In my experience, this is a good time to mention that one of the best ways to learn a codebase is to go in and document it, so if there are any wanna-be MediaWiki masters out there... :) (It is also possible that doxygen isn't picking up the member comments, though. Running doxygen locally and consulting the log it generates should give some clues, as will making sure that the comments are formatted in a way that will get picked up, although phpDoc and dOxygen are pretty friendly towards documetation styles.) -- Ben Garney Torque Technologies Director GarageGames.Com, Inc.

Tels wrote: Brion Vibber wrote: I haven't used Doxygen with PHP, so I don't know how much it is able to extract from PHP code. However, here are some notes, based on my experience using it (a few years ago) with C code: * There are assorted options that can be turned on. One option I like is the one that turns on clickable (image-mapped) context diagrams. These are generated by the dot(1) program of the Graphviz suite. The XML output option can be useful, if anyone wants to do analysis of the extracted information (I might :-). * Although Doxygen can extract some information from the code, it really starts to shine when the programmers have added some mark-up. This consists of specially-formatted comment blocks, placed just before the code that defines data structures, functions, etc. Here's an example: /*! \brief Brief description. * Brief description continued. * * Detailed description starts here. */ The "\brief" tag is one of several dozen that can be used to specify particular information. Common tags include \def, \file, \fn, \param, and \var. The more information Doxygen is given, the better documentation it can produce. * Doxygen is quite customizable. If you don't like the way the pages look, it's not that hard to change them. Of course, this will saddle you with maintenance issues when Doxygen gets updated... * The Doxygen manual is quite extensive (132 pages) and very readable. I have also found the author to be responsive. Finally, there is an active mailing list. For more infor- mation, visit the Doxygen web site: http://www.stack.nl/~dimitri/doxygen/ -r -- http://www.cfcl.com/rdm Rich Morin http://www.cfcl.com/rdm/resume rdm(a)cfcl.com http://www.cfcl.com/rdm/weblog +1 650-873-7841 Technical editing and writing, programming, and web development

On 4/18/06, Tels <nospam-abuse(a)bloodgate.com> wrote: Automatically generated documentation will only ever be as good as the source code (or other data) it's generated from. So this is a symptom of classes and other interfaces not being documented well enough, not of the documentation system as such.