Dirk Reiners wrote:

>       Hi Allen,
>
>Allen Bierbaum wrote:
>  
>
>>What is the status of integrating doxygen and trac.  Did we decided 
>>where the user and developer guide would be (wiki or dox)?
>>    
>>
>
>Last time I check the doxygen plugin did not work on the OpenSG Trac. I 
>asked about it on the Trac list, but nobody had any idea, my 
>configuration seemed correct, but the links on the doxygen main page are 
>just wacky. Putting the full links in works (like 
>http://opensg.vrsource.org/trac/doxygen/html/annotated.html instead of 
>the http://opensg.vrsource.org/trac/annotated.html from hte doxygen 
>tab). I assume it's not abig thing, but haven't time to look into it.
>
>  
>
>>This morning I was thinking about how to integrate doxygen with trac and 
>>I thought it would be very nice if we could use doxygen aliases as 
>>commands.  So then in the doxygen comments we could do something like:
>>
>>/*!  A method
>>*
>>* This does something. See devguide(method) for more information.
>>*
>>* \param Takes any enum what works with oglcmd(glEnable)
>>* \bugs There is a bug in this method.  tracbug(32)
>>*/
>>    
>>
>
>Why do you need devguide? That's a doxygen-internal link and should work 
>just fine.
>  
>
If the devguide was being done collaboratively on the wiki.  As it 
stands now with the dev guide in dox files, we wouldn't need it but IMHO 
we lose a lot of abilities we would have if the guides were on the wiki 
instead.

>>I looked into it a bit with doxygen and it looks like this is something 
>>they want to.  See #28 on http://www.stack.nl/~dimitri/doxygen/todo.html.
>>
>>Does anyone on the list have any experience with the doxygen code?  How 
>>hard would it be to add something like this?
>>    
>>
>
>No clue. I've looked at some doxygen code, but not at that part. In 
>general doxygen is not very well structured/documented, but reasonable 
>understandable. Given that this will need ot change the scanner it might 
>be a little nasty, though. I can take a look at it, I wanted to look for 
>something else anyway.
>  
>
Ok.  That does sound a bit nasty.  I took a look at the code at it seems 
like a mess to me.

>The alternative would be to fix the doxygen plugin to run the HTML text 
>through the wiki module to support actual Trac links in the 
>documentation. Probably more trouble though, as we would need to watch 
>for lots of other things.
>  
>
Yep, that could be a problem.  It may be easier to not run it through a 
full wiki processor, but just through some customizable replacement 
rules.  Of course the doxygen documentation wouldn't look right when a 
user generates it locally though.

-Allen

>       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

Reply via email to