Hi, I don't have any experience with writting doxygen documentation, so feel free to setup something and I will adapt to it ;)
Vladimir On so 30. května 2009, Laurent Monin wrote: > Klaus Ethgen a écrit : > > -----BEGIN PGP SIGNED MESSAGE----- > > Hash: SHA512 > > > > Hi folks, > > Hi Klaus, > > > now it is "Pfingsten" and I sit at $HOME with time left to do some nice > > work. So I came to the doxygen point. :-) > > > > Am Fr den 24. Apr 2009 um 14:48 schrieb Laurent Monin: > >> FYI, preliminary support for doxygen was added in revision 1550. > >> Note that the code is not "doxygenated" yet though ... > > > > There should be a minimal style definition how we should use it. > > > > I would recommend the following: > > - - Double star syntax and _not_ the QT-Syntax > > -> It is a bit easier to type. ;-) > > Ok for me. > > > - - explicit brief definition (\brief) > > Ok. > > > - - The backslash style for commands (\brief ...) (I like the \ more as > > the grey level is better when you read the source. However that could > > also be a _pro_ for @ ... What do you think?) > > Ok. \ seems more widely used. > > > - - Documentation orientated to developer. What I mean is that we have no > > API for geeqie so the documentation should mostly help new developers > > to get into the code. > > Yes. > > > - - Use of \deprecated for functions who are in the way of been reworked > > or deleted. > > Yes. > > > If there is nothing against this rules I would add it to the coding > > document. > > Agreed. > > Regards, > > Zas > ------------------------------------------------------------------------------ Register Now for Creativity and Technology (CaT), June 3rd, NYC. CaT is a gathering of tech-side developers & brand creativity professionals. Meet the minds behind Google Creative Lab, Visual Complexity, Processing, & iPhoneDevCamp as they present alongside digital heavyweights like Barbarian Group, R/GA, & Big Spaceship. http://p.sf.net/sfu/creativitycat-com _______________________________________________ Geeqie-devel mailing list Geeqie-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/geeqie-devel
