From ae033324fed6ff9b3febe12b5777f19c04e065d2 Mon Sep 17 00:00:00 2001 From: albert-github Date: Sun, 27 Dec 2015 15:28:03 +0100 Subject: Documentation small corrections --- doc/arch.doc | 8 ++++---- doc/grouping.doc | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/arch.doc b/doc/arch.doc index 7876fb9..488cb95 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -188,7 +188,7 @@ could extract information from the XML output. Possible tools could be:

Debugging

Since doxygen uses a lot of \c flex code it is important to understand -how \c flex works (for this one should read the man page) +how \c flex works (for this one should read the \c man page) and to understand what it is doing when \c flex is parsing some input. Fortunately, when flex is used with the `-d` option it outputs what rules matched. This makes it quite easy to follow what is going on for a @@ -240,10 +240,10 @@ $now = time; utime $now, $now, $file \endverbatim Another way to get rules matching / debugging information -from the flex code is setting LEX_FLAGS with cmake. +from the \c flex code is setting LEX_FLAGS with \c make (`make LEX_FLAGS=-d`). -Note that by running doxygen with `-d lex` you get information about which flex -codefile is used. +Note that by running doxygen with `-d lex` you get information about which +`flex codefile` is used. \htmlonly Return to the index. diff --git a/doc/grouping.doc b/doc/grouping.doc index 64102e1..dcd25db 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -128,7 +128,7 @@ This is the \ref group_label "link" to this group. The priorities of grouping definitions are (from highest to lowest): \ref cmdingroup "\\ingroup", \ref cmddefgroup "\\defgroup", \ref cmdaddtogroup "\\addtogroup", \ref cmdweakgroup "\\weakgroup". -The last command is exactly like \ref cmdaddtogroup "\\addtogroup" +The \ref cmdweakgroup "\\weakgroup" command is exactly like \ref cmdaddtogroup "\\addtogroup" with a lower priority. It was added to allow "lazy" grouping definitions: you can use commands with a higher priority in your .h files to define the hierarchy and \ref cmdweakgroup "\\weakgroup" -- cgit v0.12