Hi!

I finally finished all the doxygen comments for my modules. I modified the style of the html help a little bit to fit my taste wink I also managed to insert all the documentation of compact menu in the module header file, so I deleted the wiki entry.

I used the \defgroup tag to group all the content of each module. I suggest you doing so.

Code:
/**
 * \defgroup TrashModule Trash
 * \brief    Linked trash or stack implementation.
 * \ingroup  GenericScriptLibrary
 * \{
 * \file  trash.h
 * \brief Linked trash or stack implementation header.
 * \file  trash.c
 * \brief Linked trash or stack implementation code.
 * \file  test_trash.c
 * \brief Linked trash or stack implementation test code.
 */

// close the group at the end
/**
 * \}
 */


I think that a \brief description is a must.

The headers got a bit mixed at the end with so many comments, so I decided to insert a header in the modules refering to the included documentation.

Code:
/* The Ultimate Script Library 
-----------------------------------------------------------------------------------
   Module: Trash
   Linked trash or stack implementation.

   Read the documentation for further information: TUST\Documentation\index.html
----------------------------------------------------------------------------------- 
*/


before


after


All the rest is clearly explained into Doxygen documentation.

Last edited by txesmi; 06/21/13 22:10.