|
2 registered members (TipmyPip, Ayumi),
769
guests, and 4
spiders. |
|
Key:
Admin,
Global Mod,
Mod
|
|
|
Re: TUST or "The community library"
[Re: sivan]
#424590
06/19/13 08:23
06/19/13 08:23
|
Joined: Jun 2007
Posts: 1,337
Hiporope and its pain
txesmi
Serious User
|
Serious User
Joined: Jun 2007
Posts: 1,337
Hiporope and its pain
|
Hi! I'm reading the doxygen help in order to improve the documentation of my extensions and I changed this :
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
# If set to NO only classes defined in header files are included.
EXTRACT_LOCAL_CLASSES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = YES
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES = YES
So the config enforces to comment the objects to be documented. What do you think?
|
|
|
Re: TUST or "The community library"
[Re: txesmi]
#424798
06/21/13 21:48
06/21/13 21:48
|
Joined: Jun 2007
Posts: 1,337
Hiporope and its pain
txesmi
Serious User
|
Serious User
Joined: Jun 2007
Posts: 1,337
Hiporope and its pain
|
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  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.
/**
* \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.
/* 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.
|
|
|
Re: TUST or "The community library"
[Re: txesmi]
#425343
07/03/13 10:59
07/03/13 10:59
|
Joined: Jun 2007
Posts: 1,337
Hiporope and its pain
txesmi
Serious User
|
Serious User
Joined: Jun 2007
Posts: 1,337
Hiporope and its pain
|
Hi! Compact menu slider member limits now support fixed values, fixed variables and pointers to fixed variables. Also, all the member creation strings now can contain as much spaces and tabs as you want. The most time consuming action was writting the documentation xP @sivan: I would love to see this system running on a project
|
|
|
|
