I wholehearted agree with William here!!! I've been programming for nie on 20 years and these systems have rarely provide more insight than the code itself and a good search facility. (apart from some impressive pictures)
What I have learnt in abundance from the ruby community though is the incredible usefulness of well written TESTS AS DOCUMENTATION tool. Should you need to understand how to implement a certain class, or method, good well written tests should DEMONSTRATE exactly how and how not to do it. just my 2c keith On 28 March 2012 09:48, William Good <bkg...@gmail.com> wrote: > We have a Jenkins server at http://builds.mixxx.org/jenkins/ . > > For what it's worth I find the Doxy output for Mixxx to be relatively > unhelpful but that may change as commenting improves. > > Bill > > On Wed, Mar 28, 2012 at 12:23 PM, Maxime Bochon <maxime.boc...@gmail.com> > wrote: >> Ok, I'll do that ! >> >> Maxime >> >> PS: By the way, why did you mention Hudson ? Is there any continuous >> integration system in place for Mixxx ? (and I heard in a JUG that here is a >> war between Hudson and its fork Jenksin) >> >> Le 28 mars 2012 14:52, Daniel Schürmann <dasch...@gmx.de> a écrit : >> >>> Hello Sean, Maxime and Keith, >>> >>> here is a proposal based on your ideas: >>> >>> Let us track the "doxyfile" within the mixxx sources, as well as >>> additional images, stylesheets, and mainpage.dox. >>> >>> If its possible, we may create a separate scons target for doxygen. >>> >>> This gives the opportunity for each developer to create a up-to-date docu >>> of the current state of each branch. >>> >>> Additional it would be nice, if we have the current docu of lp:mixxx >>> always online. This could be managed by the hudson server as keith >>> mentioned. >>> >>> @Maxime: Do you like this idea? If yes, it would be nice if you can do the >>> first step and upload your branch including the doxyfie and what else is >>> required. >>> >>> Thank you, >>> >>> Daniel >>> >>> -------- Original-Nachricht -------- >>> > Datum: Wed, 28 Mar 2012 03:18:20 -0800 >>> > Von: "keithsalisb...@gmail.com" <keithsalisb...@gmail.com> >>> > An: Maxime Bochon <maxime.boc...@gmail.com> >>> > CC: Too Many DJs <mixxx-devel@lists.sourceforge.net> >>> > Betreff: Re: [Mixxx-devel] Mixxx online Doxygen >>> >>> > Definitely agree with this - compiling docs should really be managed >>> > by a commit hooks so when code is pushed the server it triggers a >>> > rebuild of the documentation tools. (As well as running continuous >>> > integration tests etc ;)) >>> > >>> > On 28 March 2012 02:29, Maxime Bochon <maxime.boc...@gmail.com> wrote: >>> > > Hi, >>> > > >>> > > I agree with the idea of better documenting the code through the >>> > > descriptive doxygen-styled comments. >>> > > >>> > > However, I'm not sure we should add doxygen generation to the scons >>> > > build process for these reasons: >>> > > - the current build process is already quite long >>> > > - the html documentation generated by doxygen is really big (<14000 >>> > > files and <100MB if I remember well) >>> > > - doxygen allows different outputs for different user needs (HTML, >>> > > Man, LaTeX, CHM... see >>> > > http://www.stack.nl/~dimitri/doxygen/output.html) >>> > > >>> > > The main point is that such a documentation is a really good help for >>> > > developers to dig into the code and get the big picture of some >>> > > modules. So I suggest that the HTML version of the Doxygen >>> > > documentation should be officially available online for the last >>> > > release of Mixxx. >>> > > >>> > > Regards, >>> > > >>> > > Maxime >>> > > >>> > > PS: currently, I use doxywizard (available in Ubunutu) to generate the >>> > > documentation through a GUI. >>> > > >>> > > >>> > > >>> > > 2012/3/28 "Daniel Schürmann" <dasch...@gmx.de>: >>> > >> 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 >>> > > >>> > > >>> > >>> > ------------------------------------------------------------------------------ >>> > > 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 >>> > >>> > >>> > >>> > -- >>> > keithsalisb...@gmail.com >>> > >>> > >>> > ------------------------------------------------------------------------------ >>> > 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 >>> >>> -- >>> NEU: FreePhone 3-fach-Flat mit kostenlosem Smartphone! >>> Jetzt informieren: http://mobile.1und1.de/?ac=OM.PW.PW003K20328T7073a >>> >>> >>> ------------------------------------------------------------------------------ >>> 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 >> >> >> ------------------------------------------------------------------------------ >> 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 > > ------------------------------------------------------------------------------ > 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 -- keithsalisb...@gmail.com ------------------------------------------------------------------------------ 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
