Dirk: Have you made any progress with testing trac and doxygen? I am running into things daily that are undocumented and I would like to know where to put the pointers asking for some developer documentation. :)
-Allen Dirk Reiners wrote: > Hi Allen, > >Allen Bierbaum wrote: > > >>And I was going to suggest that we just use the wiki for dev guide and >>tutorial and move them out of the dox. The advantages I see for this are: >> >>- It makes the documentation "live" on the web so everyone can comment, >>edit, change it. >>- There is no generation step >>- It is more direct because people don't have to edit a .dox file, test >>generate it, submit a patch, etc. >> >> >> >Generally I agree. > > >>As far as cross linking: >> - Linking from wiki to doxygen: It looks like the doxygen plugin for >>trac will help out here. We may also be able to create a simple macro >>that will create a link given the class name we want to link to. But, >>this won't be an automatic process so it will be more work then we >>current go through. >> >> >> >That shouldn't be a problem. A macro should be able to cover that easily. > > >> - Linking from doxygen to wiki: I wonder if we can configure a >>doxygen alias that would help with this so that all we had to do in the >>doxygen comments was to call the alias and list the name of the ref >>guide page to link to. A define may also work. I haven't tried either >>of these options though so I don't know if they will work. >> >> >> >I need to try that, as this is the critical part. This has to be working >and easy to use from within doxygen, or people won't. :( > >Allen Bierbaum wrote: > > >>Did we ever finalize on a documentation standard? The wiki page about >>it seems to still be in a state of flux. (see: >>http://opensg.vrsource.org/trac/wiki/Dev/CodingStandard ) >> >> >> >I commented on the comments (see bottom). > > >>I would like to start documenting things that I reverse-engineer, but I >>want to make sure I do it right. :) >> >> >Go ahead, every documented function is a good function. ;) > >Yours > > Dirk > > >------------------------------------------------------------------------- >Take Surveys. Earn Cash. Influence the Future of IT >Join SourceForge.net's Techsay panel and you'll get the chance to share your >opinions on IT & business topics through brief surveys -- and earn cash >http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV >_______________________________________________ >Opensg-users mailing list >[email protected] >https://lists.sourceforge.net/lists/listinfo/opensg-users > > > ------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys -- and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV _______________________________________________ Opensg-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/opensg-users
