>> 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: > http://docs.google.com/Doc?id=dgn42tzv_0fsbjmjgp > > If you want to be able to edit, just email me your google account > name and I'll add you as a collaborator.
Good initiative Greg. I don't have or yet want a google account, so I'll add 2c here. One thing I'm totally against is right markers in block comments, which luckily don't appear in fltk code that I have looked at, but 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 it readable in the editor and avoid lots of raggedy short and overly-long text lines. I would prefer that we all agree to omit the left markers: /** \brief The one-liner The detailed description here, on more than one line. \param x \return y */ Cheers D, _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
