forums.ps2dev.org Forum Index forums.ps2dev.org
Homebrew PS2, PSP & PS3 Development Discussions
 
 FAQFAQ   SearchSearch   MemberlistMemberlist   UsergroupsUsergroups   RegisterRegister 
 ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

Doxygen

 
Post new topic   Reply to topic    forums.ps2dev.org Forum Index -> PS2 Development
View previous topic :: View next topic  
Author Message
mrbrown



Joined: 17 Jan 2004
Posts: 1536

PostPosted: Wed Feb 18, 2004 9:02 pm    Post subject: Doxygen Reply with quote

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?
Back to top
View user's profile Send private message
blackdroid



Joined: 17 Jan 2004
Posts: 564
Location: Sweden

PostPosted: Wed Feb 18, 2004 11:53 pm    Post subject: Reply with quote

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.
_________________
Kung VU
Back to top
View user's profile Send private message Visit poster's website
blackdroid



Joined: 17 Jan 2004
Posts: 564
Location: Sweden

PostPosted: Thu Feb 19, 2004 12:07 am    Post subject: Reply with quote

though I could let my procmail kick the docbuilder each time a ps2cvs mail arrives.
_________________
Kung VU
Back to top
View user's profile Send private message Visit poster's website
mrbrown



Joined: 17 Jan 2004
Posts: 1536

PostPosted: Thu Feb 19, 2004 8:52 am    Post subject: Reply with quote

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 :).
Back to top
View user's profile Send private message
blackdroid



Joined: 17 Jan 2004
Posts: 564
Location: Sweden

PostPosted: Thu Feb 19, 2004 9:22 am    Post subject: Reply with quote

Ill put it down on my TODO list then. someday.
_________________
Kung VU
Back to top
View user's profile Send private message Visit poster's website
Display posts from previous:   
Post new topic   Reply to topic    forums.ps2dev.org Forum Index -> PS2 Development All times are GMT + 10 Hours
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group