Commit 2fdf6f3b authored by Matthias Braun's avatar Matthias Braun
Browse files

docu: further improvements

parent ea177aef
...@@ -270,7 +270,7 @@ SUBGROUPING = YES ...@@ -270,7 +270,7 @@ SUBGROUPING = YES
# be useful for C code in case the coding convention dictates that all compound # be useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name. # types are typedef'ed and only the typedef is referenced, never the tag name.
TYPEDEF_HIDES_STRUCT = NO TYPEDEF_HIDES_STRUCT = YES
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk. # determine which symbols to keep in memory and which to flush to disk.
...@@ -429,25 +429,25 @@ SORT_BY_SCOPE_NAME = NO ...@@ -429,25 +429,25 @@ SORT_BY_SCOPE_NAME = NO
# disable (NO) the todo list. This list is created by putting \todo # disable (NO) the todo list. This list is created by putting \todo
# commands in the documentation. # commands in the documentation.
GENERATE_TODOLIST = YES GENERATE_TODOLIST = NO
# The GENERATE_TESTLIST tag can be used to enable (YES) or # The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test # disable (NO) the test list. This list is created by putting \test
# commands in the documentation. # commands in the documentation.
GENERATE_TESTLIST = YES GENERATE_TESTLIST = NO
# The GENERATE_BUGLIST tag can be used to enable (YES) or # The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug # disable (NO) the bug list. This list is created by putting \bug
# commands in the documentation. # commands in the documentation.
GENERATE_BUGLIST = YES GENERATE_BUGLIST = NO
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting # disable (NO) the deprecated list. This list is created by putting
# \deprecated commands in the documentation. # \deprecated commands in the documentation.
GENERATE_DEPRECATEDLIST= YES GENERATE_DEPRECATEDLIST= NO
# The ENABLED_SECTIONS tag can be used to enable conditional # The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif. # documentation sections, marked by \if sectionname ... \endif.
...@@ -741,7 +741,7 @@ VERBATIM_HEADERS = YES ...@@ -741,7 +741,7 @@ VERBATIM_HEADERS = YES
# of all compounds will be generated. Enable this if the project # of all compounds will be generated. Enable this if the project
# contains a lot of classes, structs, unions or interfaces. # contains a lot of classes, structs, unions or interfaces.
ALPHABETICAL_INDEX = YES ALPHABETICAL_INDEX = NO
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
...@@ -1391,12 +1391,12 @@ CLASS_GRAPH = YES ...@@ -1391,12 +1391,12 @@ CLASS_GRAPH = YES
# indirect implementation dependencies (inheritance, containment, and # indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes. # class references variables) of the class with other documented classes.
COLLABORATION_GRAPH = YES COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies # will generate a graph for groups, showing the direct groups dependencies
GROUP_GRAPHS = YES GROUP_GRAPHS = NO
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling # collaboration diagrams in a style similar to the OMG's Unified Modeling
...@@ -1414,14 +1414,14 @@ TEMPLATE_RELATIONS = YES ...@@ -1414,14 +1414,14 @@ TEMPLATE_RELATIONS = YES
# file showing the direct and indirect include dependencies of the file with # file showing the direct and indirect include dependencies of the file with
# other documented files. # other documented files.
INCLUDE_GRAPH = YES INCLUDE_GRAPH = NO
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or # documented header file showing the documented files that directly or
# indirectly include this file. # indirectly include this file.
INCLUDED_BY_GRAPH = YES INCLUDED_BY_GRAPH = NO
# If the CALL_GRAPH and HAVE_DOT options are set to YES then # If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function # doxygen will generate a call dependency graph for every global function
......
...@@ -804,7 +804,9 @@ FIRM_API ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs, ...@@ -804,7 +804,9 @@ FIRM_API ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs,
/** @} */ /** @} */
/** @defgroup ir_cons Graph Construction Support /**
* @ingroup ir_graph
* @defgroup ir_cons Construction Support
* @{ * @{
*/ */
......
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
/** /**
* @ingroup ir_graph * @ingroup ir_graph
* @defgroup ir_node Graph Nodes * @defgroup ir_node Nodes
* *
* ir_node - a datatype representing a Firm node * ir_node - a datatype representing a Firm node
* *
......
...@@ -43,10 +43,6 @@ ...@@ -43,10 +43,6 @@
* Independent of compiler flag it removes Tuples from cf edges, * Independent of compiler flag it removes Tuples from cf edges,
* Bad predecessors from Blocks and Phis, and unnecessary predecessors of End. * Bad predecessors from Blocks and Phis, and unnecessary predecessors of End.
* Destroys backedge information. * Destroys backedge information.
*
* @bug Chokes on Id nodes if called in a certain order with other
* optimizations. Call local_optimize_graph() before to remove
* Ids.
*/ */
FIRM_API void optimize_cf(ir_graph *irg); FIRM_API void optimize_cf(ir_graph *irg);
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment