This is pretty amazing i think take a look at some Doxygen output:
I think its really worth learning + it will save you about a week or 2′s worth of documentation:
What you want to do is go to your projects directory and:
$ sudo apt-get install doxygen
$ doxygen -g
$ emacs -nw Doxyfile
$ echo “Now go through each of these options in the config file use CTRL-S to start searching in emacs
”
EXTRACT_ALL = YES
Extract documentation even from those elements you haven’t yet commented.
INLINE_SOURCE = YES
Extract the relevant parts of the source and associate them with your description.
HAVE_DOT = YES
Use Graphviz for class and collaboration diagrams.
CALL_GRAPH = YES
Generate a dependency graph for functions and methods.
GENERATE_LATEX = NO
Skip generating LaTeXsources for
RECURSIVE = YES
To go through each of your directorys! Probably the most important.
FILE_PATTERNS = *.c *.h
The source files you want to document!
echo “Now run”
$ doxygen Doxyfile
#Hope it works
Finally to do documentation you need to go to your code and do documenation like:
-
/**
-
* Return the size of the list.
-
*
-
* \return returns the size of the list as an int
-
* \param list The List you want to add the item to
-
*/
-
extern int size( LinkedList** list) {
-
int counter=0;
-
LinkedList *tmp=*list;
-
-
if(tmp->contents != NULL) {
-
struct ListNode *next= tmp;
-
counter++;
-
while(next->nextnode != NULL){
-
next= next->nextnode;
-
counter++;
-
}
-
return counter;
-
}
-
else
-
return counter;
-
}
-
I bookmarked this site, Thank you for good job!