uGFX/ugfx
2
0
Fork 0
Code Issues 2 Pull Requests Projects Releases Wiki Activity

doxygen

Browse Source
This commit is contained in:
Joel Bodenmann 2014-04-29 17:03:48 +02:00
parent 70c96543fc
commit 53a523b360
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doxygenfile
View File

@ -230,13 +230,11 @@ TAB_SIZE = 2
# "Side Effects:". You can put \n's in the value part of an alias to insert # "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines. # newlines.
ALIASES = "iclass=@par Function Class:\n This is an <b>I-Class</b> API, this function can be invoked from within a system lock zone by both threads and interrupt handlers." \ ALIASES = "iclass=@par Function Class:\n This is an <b>I-Class</b> API, this function can be invoked from within a system lock zone by both threads and interrupt handlers." \
"sclass=@par Function Class:\n This is an <b>S-Class</b> API, this function can be invoked from within a system lock zone by threads only." \ "sclass=@par Function Class:\n This is an <b>S-Class</b> API, this function can be invoked from within a system lock zone by threads only." \
"api=@par Function Class:\n Normal API, this function can be invoked by regular system threads but not from within a lock zone." \ "api=@par Function Class:\n Normal API, this function can be invoked by regular system threads." \
"notapi=@par Function Class:\n Not an API, this function is for internal use only." \ "notapi=@par Function Class:\n Not an API, this function is for internal use only." \
"isr=@par Function Class:\n Interrupt handler, this function should not be directly invoked." \ "isr=@par Function Class:\n Interrupt handler, this function should not be directly invoked." \
"init=@par Function Class:\n Initializer, this function just initializes an object and can be invoked before the kernel is initialized." \
"special=@par Function Class:\n Special function, this function has special requirements see the notes."
# This tag can be used to specify a number of word-keyword mappings (TCL only). # This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class" # A mapping has the form "name=value". For example adding "class=itcl::class"
@ -2051,7 +2049,7 @@ PERL_PATH = /usr/bin/perl
# powerful graphs. # powerful graphs.
# The default value is: YES. # The default value is: YES.
CLASS_DIAGRAMS = YES CLASS_DIAGRAMS = NO
# You can define message sequence charts within doxygen comments using the \msc # You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see: # command. Doxygen will then run the mscgen tool (see:
@ -2124,7 +2122,7 @@ DOT_FONTPATH =
# The default value is: YES. # The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES. # This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES CLASS_GRAPH = NO
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation # graph for each documented class showing the direct and indirect implementation
@ -2198,7 +2196,7 @@ INCLUDED_BY_GRAPH = NO
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES. # This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = YES CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method. # dependency graph for every global function or class method.