Hi Sean, Hi Maxime, 

I like the idea having a doxygen integrated in Scons. 

We should consider to add doxygen comments to each new function header. 

It may look like this: 

//! \brief writes a Human readable text file, useful for pubishing the
//! playlists on the web
//! \param file_str path of the file to write  
//! \param pPlaylistTableModel ponter to the source playlist 
//! \param writeTimestamp if true an additional relative timestamp is written
//! \return true on success 
bool ParserCsv::writeReadableTextFile(const QString &file_str, 
BaseSqlTableModel* pPlaylistTableModel, bool writeTimestamp)
{

If we agree to this style, we may add it to our coding guidelines.

Kind regards, 

Daniel 



-------- Original-Nachricht --------
> Datum: Tue, 27 Mar 2012 22:20:11 +0200
> Von: "Sean M. Pappalardo - D.J. Pegasus" <spappala...@mixxx.org>
> An: mixxx-devel@lists.sourceforge.net
> Betreff: Re: [Mixxx-devel] Mixxx online Doxygen

> 
> 
> On 03/27/2012 07:59 AM, Maxime Bochon wrote:
> > I didn't find an online documentation for Mixxx, so I did my own with
> > Doxygen to be able to browse the code easily and anywhere.
> 
> This is awesome, thank you! The big question is: would you like to make 
> it official and add Doxygen generation to our scons build process? :)
> 
> Sincerely,
> Sean M. Pappalardo
> "D.J. Pegasus"
> Mixxx Developer - Controller Specialist
> 

-- 
Empfehlen Sie GMX DSL Ihren Freunden und Bekannten und wir
belohnen Sie mit bis zu 50,- Euro! https://freundschaftswerbung.gmx.de

------------------------------------------------------------------------------
This SF email is sponsosred by:
Try Windows Azure free for 90 days Click Here 
http://p.sf.net/sfu/sfd2d-msazure
_______________________________________________
Get Mixxx, the #1 Free MP3 DJ Mixing software Today
http://mixxx.org


Mixxx-devel mailing list
Mixxx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mixxx-devel

Reply via email to