usbpicprog-technical

[Usbpicprog-technical] Using doxygen to document internal functions

[Francesco M. <f18...@ya...>]

Hi Frans,
   I think that even if upp_wx internals are quite simple (at least for now) and linear, it would be better to use doxygen-styled comments in the headers to document the internal interfaces of the various classes instead of plain comments.

This would greatly help other developers interested in the project to contribute modifications and new features...

Sounds good?

Francesco

__________________________________________________
Do You Yahoo!?
Poco spazio e tanto spam? Yahoo! Mail ti protegge dallo spam e ti da tanto spazio gratuito per i tuoi file e i messaggi 
http://mail.yahoo.it 

Re: [Usbpicprog-technical] Using doxygen to document internal functions

[Frans S. <fra...@gm...>]

Hi Francesco,

I think Doxygen is a good idea, the thing is that I have never done it, 
how do I start?

Cheers,

Frans

Francesco Montorsi wrote:
> Hi Frans,
>    I think that even if upp_wx internals are quite simple (at least for now) and linear, it would be better to use doxygen-styled comments in the headers to document the internal interfaces of the various classes instead of plain comments.
>
> This would greatly help other developers interested in the project to contribute modifications and new features...
>
> Sounds good?
>
> Francesco
>
> __________________________________________________
> Do You Yahoo!?
> Poco spazio e tanto spam? Yahoo! Mail ti protegge dallo spam e ti da tanto spazio gratuito per i tuoi file e i messaggi 
> http://mail.yahoo.it 
>
> ------------------------------------------------------------------------------
> Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco, CA
> -OSBC tackles the biggest issue in open source: Open Sourcing the Enterprise
> -Strategies to boost innovation and cut costs with open source participation
> -Receive a $600 discount off the registration fee with the source code: SFAD
> http://p.sf.net/sfu/XcvMzF8H
> _______________________________________________
> Usbpicprog-technical mailing list
> Usb...@li...
> https://lists.sourceforge.net/lists/listinfo/usbpicprog-technical
>   

Re: [Usbpicprog-technical] Using doxygen to document internal functions

[Francesco M. <f18...@ya...>]

Hi Frans,

Frans Schreuder ha scritto:
> I think Doxygen is a good idea, the thing is that I have never done it, 
> how do I start?
I've just committed the necessary setup to generate the manual.

To generate it (it's a good thing to NOT commit to SVN repo the HTML files 
generated by doxygen), just cd to upp_wx/docs and run "doxygen", then "firefox 
html/index.html".

To use doxygen you just need to write the comments in the headers with a special 
syntax.
E.g. instead of /* */ if you want that comment to document the function that 
follows it, just must use /** */.
Instead of // use /// or //!

More info at: http://www.stack.nl/~dimitri/doxygen/docblocks.html

Bye,
Francesco


PS: I've not committed doxyfied comments for PicType since I'm modifying it for 
the XML-data load stuff (see the other mail).

--