summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/config.doc14
-rw-r--r--doc/starting.doc20
2 files changed, 29 insertions, 5 deletions
diff --git a/doc/config.doc b/doc/config.doc
index c8ced5d..bc27a16 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -538,21 +538,27 @@ description.
that doxygen normally generates:
\verbatim
-H1 { text-align: center }
+H1 { text-align: center; }
A.qindex {}
A.qindexRef {}
A.el { text-decoration: none; font-weight: bold }
A.elRef { font-weight: bold }
A.code { text-decoration: none; font-weight: normal; color: #4444ee }
A.codeRef { font-weight: normal; color: #4444ee }
-A.gl:link { color: #ffffff }
-A.gl:visited { color: #ffffff }
-A.gl { text-decoration: none; font-weight: bold; background-color: #ff8080 }
DL.el { margin-left: -1cm }
DIV.fragment { width: 100%; border: none; background-color: #eeeeee }
DIV.in { margin-left: 16 }
DIV.ah { background-color: black; margin-bottom: 3; margin-top: 3 }
TD.md { background-color: #f2f2ff }
+DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight
+DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller }
+FONT.keyword { color: #008000 }
+FONT.keywordtype { color: #008060 }
+FONT.keywordflow { color: #e08000 }
+FONT.comment { color: #800000 }
+FONT.preprocessor { color: #806020 }
+FONT.stringliteral { color: #002080 }
+FONT.charliteral { color: #008080 }
\endverbatim
\anchor cfg_html_align_members
diff --git a/doc/starting.doc b/doc/starting.doc
index c9e4dfb..cd52250 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -742,7 +742,7 @@ Then by default doxygen will feed the following to its parser:
You can disable all preprocessing by setting
\ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" to \c
-NO in the configuation file. In the case above doxygen will then read
+NO in the configuation file. In the case above doxygen will then reads
both statements!
In case you want to expand the \c CONST_STRING macro, you should set the
@@ -847,6 +847,24 @@ for class QList is to define:
PREDEFINED = QListT:=QList
\endverbatim
+Here is example provided by Valter Minute that helps doxygen to
+wade through the boilerplate code in Microsoft's ATL library:
+
+\verbatim
+PREDEFINED = DECLARE_REGISTRY_RESOURCEID=// \
+ DECLARE_PROTECT_FINAL_CONSTRUCT=// \
+ BEGIN_COM_MAP=/* \
+ END_COM_MAP=*/// \
+ BEGIN_PROP_MAP=/* \
+ END_PROP_MAP=*/// \
+ BEGIN_MSG_MAP=/* \
+ END_MSG_MAP=*/// \
+ DECLARE_VIEW_STATUS=// \
+ "STDMETHOD(a)=HRESULT a" \
+ "ATL_NO_VTABLE= "\
+ "__declspec(a)= "\
+\endverbatim
+
As you can see doxygen's preprocessor is quite powerful, but if you want
even more flexibility you can always write an input filter and specify it
after the \ref cfg_input_filter "INPUT_FILTER" tag.