Re: [fltk.development] Doxygen commenting in fltk

2009-03-15 Thread Greg Ercolano
Duncan Gibson wrote: I'm also not keen on left markers in multiline comments: /** * \brief The one-liner * * The detailed description here, * on more than one line. * \param x * \return y */ because it's too much faffing about when you need to reformat, and I reformat to keep

Re: [fltk.development] Doxygen commenting in fltk

2009-03-15 Thread Albrecht Schlosser
Greg Ercolano wrote: Duncan Gibson wrote: I'm also not keen on left markers in multiline comments: /** * \brief The one-liner * * The detailed description here, * on more than one line. * \param x * \return y */ because it's too much faffing about when you need to reformat,

Re: [fltk.development] Doxygen commenting in fltk

2009-03-15 Thread Greg Ercolano
Albrecht Schlosser wrote: We did already discuss this, and we decided to use the format as it is in FLTK 1.3: without left markers/stars. OK -- Good to know. I'll change it in my doc, and hopefully we can fix the standards doc when we merge it back. Just pulled fltk2 to

[fltk.development] Doxygen commenting in fltk

2009-03-14 Thread Greg Ercolano
Greg Ercolano wrote: Greg Ercolano wrote: I'd also be happy to start or assist in the creation of an FLTK doxygen standards page that describes how docs should appear, so that new docs follow a certain format. Great; I'll see if I can give it a start. BTW, looks like

Re: [fltk.development] Doxygen commenting in fltk

2009-03-14 Thread Greg Ercolano
Greg Ercolano wrote: As a start, I've created a new doc, copying in the doxygen part of the FLTK coding standards, and will add some stuff from this thread, as well as some other notes from the last few days. I've 'published' the doc so that it should be publicly viewable at:

[fltk.development] Doxygen commenting in fltk

2009-03-13 Thread Greg Ercolano
At first I tried using grouping.. this is supposed to work according to doxygen chapter 5.2 on Member Groups: /*...@{*/ /** Sets/gets the sortorder, used for sorting the tree items. */ void sortorder(Fl_Tree_Sort val) { _sortorder = val; } FL_Tree_Sort sortorder() const {