-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA512 Hi Oscar,
Am Sa den 30. Mai 2009 um 19:08 schrieb Oscar Miras: > > 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. Let me explain it a bit more verbose without telling the whole doxygen documentation. The doxygen system need the help of the programmer to detect the documentation proper. Therefore you have to use a special syntax (similar to javadoc but somewhat different). - - Start of a documentation comment is either '/**' or '/*!' the following lines can (should(?)) or cannot be prepended by ' *'. - - Inside the special comment there can be some commands. They start with either a '\' or a '@'. Lets take your example. > 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) Now rewrite it to allow doxygen to use it. /** * It loads next PanItem ( thumbails or image) located in pw->queue_pi. * * \return boolean with the following conditions * - FALSE * -# if (!pw->queue) : The queue is empty. * -# if (image_loader_start(pw->il)) : We were succesful loading an * image. * -# if (thumb_loader_start(pw->tl, pi->fd)) : We were succesful * loading a thumbail * - TRUE * -# if (!pw->queue_pi->fd) : If we don't find a PanItem descriptor; * just ignore it ( maybe it's not an image file). * -# At the end of function. PanItem need to be reconsidered again * once its state changed. */ static gboolean pan_queue_step(PanWindow *pw) 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) iQEVAwUBSiF9dJ+OKpjRpO3lAQq2Lwf/Z4nawnLvDNBZF3DxEI9pZfBE3rEzUsno 736dzhM1M7nmxS4/OcA332BjW9jP3eTqkiDmiRgIlk7Ocuj1j4FKmOkYntPsDpz2 DlZCl/wTP7XLy+b/V+se241HVBOSG4PWMWDyGSLT1J54wZLcClXysDhK5b4m71sq BIKzv8Uy9VIebJeZyodlw7Hidf528Q8VOYpUwtI0TGX2hcfqqbCgy9aIEfOIx2x4 m8eJ/QS/+z/W7pkbdLnrAShVtxUEKAk8q3mGDRjrBPZm5DAvrlQPN6XZRhH6u4XG U4KRKm+HiuC2Jy8EvPTjEF3hK8LtbHQwLvmQn3skN0KSPFN3k0jo4g== =f/J3 -----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
