2009/5/30 Klaus Ethgen <klaus+gee...@ethgen.de <klaus%2bgee...@ethgen.de>>
> -----BEGIN PGP SIGNED MESSAGE----- > Hash: SHA512 > > Hi folks, > > now it is "Pfingsten" and I sit at $HOME with time left to do some nice > work. So I came to the doxygen point. :-) $HOME? Freak! :P > > > 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. ;-) > > - - explicit brief definition (\brief) > > - - 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?) > I don't understand a word xD. In Pan view Integration i'm writting this kind information before pan functions: For function static gboolean pan_queue(PanWindow *pw): /* It loads next PanItem ( thumbails or image) located in pw->queue_pi. returns FALSE: we hace reached a state where we have finished working with the present PanItem. 1. if (!pw->queue) : The queue is empty. 2. if (image_loader_start(pw->il)) : We were succesful loading an image. 3. if (thumb_loader_start(pw->tl, pi->fd)) : We were succesful loading a thumbail return TRUE: 1. if (!pw->queue_pi->fd) : If we don't find a PanItem descriptor; just ignore it ( maybe it's not an image file). 2. At the end of function. PanItem need to be reconsidered again once its state changed. */ static gboolean pan_queue_step(PanWindow *pw) > > - - 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. > > - - Use of \deprecated for functions who are in the way of been reworked > or deleted. I understand this :) . Where should we put \deprected ; at first of each function too? > > > If there is nothing against this rules I would add it to the coding > document. > Agreed. > > Regards > Klaus > - -- > Klaus Ethgen http://www.ethgen.de/ > pub 2048R/D1A4EDE5 2000-02-26 Klaus Ethgen <kl...@ethgen.de> > Fingerprint: D7 67 71 C4 99 A6 D4 FE EA 40 30 57 3C 88 26 2B > -----BEGIN PGP SIGNATURE----- > Version: GnuPG v1.4.9 (GNU/Linux) > > iQEVAwUBSiFfDp+OKpjRpO3lAQrylggAh9MAvpM4VzUyqRxF0Oj1yJF0ORntO1WB > Hsn6qbNQ0YRm9Xipng9HkFZDJhNeVjlfWGrPG56eDxZhmo4FPr3hsrptWrczn21B > ZJ+zGvoYvmoN0WoX1EU/Ef9xfWqthuRTST9iBwoFjrIqo5NmP5ghSIxgBAY70DAb > QFmNE5abGN7FXe6+BpcfILR/veo0uXH73o+OAOU9YnOcvS2cMTP8mnOwywgV2WuK > GICOfyXeR5uZHcqnGvxkO/cEp6EzMosK8HSCw/wE+yORTwaGuGYq+c+JSkF0WiCE > stKVULPhjmDh+zbuOde1lvndGCJ1ANAQDuhrtQnK+gPT2eIjs8hW/g== > =286l > -----END PGP SIGNATURE----- > > > ------------------------------------------------------------------------------ > 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 >
------------------------------------------------------------------------------ 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
