[Doxygen-users] Some feedback from a lot of users
Brought to you by:
dimitri
From: Emilio R. <emi...@ma...> - 2001-06-06 07:05:09
|
Hallo! I'm introducing doxygen use in my company, and I got enthusiastic response from almost all developers; this tool is very useful, and performs fine. All developers gave me some feedback; some are common to all of them, so i thought it could be useful to you to know about it: 1) A kind of automatic grouping is needed, e.g: /*! Bit masks for XXXX field: */ #define MASK1 0x80 /*!< bit meaning... */ #define MASK2 0x0F /*!< bits meaning... */ This should generate a little paragraph with title "Bit masks for XXXX field:", or something similar 2) Special additional comments spreaded through all the function body grouped under an automatic tag relative to that funcion documentation, e.g: /*! ...function header... */ void MyFunc(void) { int i; .... /*! Developer's notes 1... */ .... /*! Developer's notes 2... */ .... } This should generate an additional paragraph under MyFunc() documentation, something like: .... Developer's notes: Developer's notes 1... Developer's notes 2... I don't know if these needs are difficult to satisfy, and surely they are questionable. Anyway I hope these feedback should be useful to doxygen's developers. Thank you, Emilio Riva |