[asterisk-dev] Doxygen clarification

Johansson Olle E oej at edvina.net
Mon Nov 26 13:38:28 CST 2007


Friends,
Going through the source code I find many code declarations like:

    /*! Doxygen comment explaining function one and two */
    void functionone();

    void functiontwo();


Please observe that doxygen has no artificial intelligence. Each  
function needs its
own documentation, so copy and paste to make sure that doxygen  
documentation
exists for all functions.

Better to duplicate a few lines than don't have doc for functiontwo().

     /*! Doxygen comment explaining function one  */
     void functionone();

     /*! Doxygen comment explaining function two */
     void functiontwo();


Thanks!

/O



More information about the asterisk-dev mailing list