Doxygen

Post by **mrbrown** » Wed Feb 18, 2004 9:02 pm

This first question is mainly for blackdroid. I guess when you autogen the docs, you use a local doxy.conf instead of the one from the CVS module? I ask because for ps2lib, I added the DOXYGEN predefine to doxy.conf, so that doxygen could preprocess "wrapped" function calls (e.g. #ifdef F_SifLoadModule) correctly. Without "#if defined(F_SifLoadModule) || defined(DOXYGEN)" those funcs are completely invisible to doxygen. Can you copy out the CVS doxy.conf before generating the docs? Or otherwise copy out the contents of say ps2lib-doc, generated straight from CVS?

The second question or idea I had was, it would be nice on CVS checkin, to check the module for doxy.conf, and if it's there to automatically update docs.ps2dev.org. I know the checkin script is easy, but is it possible on the back end to do this? Perhaps a special mail message that gets parsed by doc.ps2dev.org's mail server to trigger it?

Post by **blackdroid** » Wed Feb 18, 2004 11:53 pm

1. yeah ill change the doc builder to use checked out doxy.conf and copy the dir over.

2. is it really needed ? I mean how often do you think someone will check docs.ps2dev.org for the recent changes ? I can up the frequency of the build script to once an hour :) if you only want to check how it looks, build the docs locally.

Post by **blackdroid** » Thu Feb 19, 2004 12:07 am

though I could let my procmail kick the docbuilder each time a ps2cvs mail arrives.

Post by **mrbrown** » Thu Feb 19, 2004 8:52 am

I think the procmail filter would be pretty cool .. you never know when someone will check (yeah I know, not everybody is rushing to write docs :P). And IMO it still would be nice to see the results ASAP (yeah, I did all my checking locally, before committing, but still :).

Post by **blackdroid** » Thu Feb 19, 2004 9:22 am

Ill put it down on my TODO list then. someday.