Changes between Version 30 and Version 31 of DoxygenPlugin

Timestamp:

Sep 5, 2006, 9:29:17 AM (18 years ago)

Author:

Christian Boos

Comment:

Improve section about Doxygen configuration

DoxygenPlugin

@@ -41 +41 @@
 
 == Example ==
-
+----
 === Installation ===
 
@@ -125 +125 @@
 === Configuring Doxygen ===
 
-The only configuration tags that are required in to make this plugin work are '{{{GENERATE_HTML}}}' and '{{{GENERATE_TREEVIEW}}}'. Since this plugin just embeds the html pages generated by doxygen you will need to define a custom header and footer even if it will be containing only blank line. 
+The only configuration setting in the Doxyfile that is required to make this plugin work is
+[http://www.stack.nl/~dimitri/doxygen/config.html#cfg_generate_html GENERATE_HTML].
+{{{
+#!comment
+GENERATE_TREEVIEW doesn't seem to be needed... Why was this part of the mandatory settings?
+}}}
+
+Since this plugin just embeds the html pages generated by doxygen you will need to define a custom header and footer even if it will be containing only blank line. 
 
 {{{
@@ -131 +138 @@
 HTML_FOOTER            = TracFooter.html
 }}}
+See [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_header HTML_HEADER]
+and [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_footer HTML_FOOTER].
 
 These files must contain something, a blank line is sufficient, or doxygen will put in the defaults. You can put there you own CSS style as in following example:
@@ -138 +147 @@
 </style>
 }}}
-
 and my !TracFooter.html contains a blank line. 
 
-To enable the search option the {{{SEARCHENGINE}}} tag must be set to 'YES'.
+To enable the search option, the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_searchengine SEARCHENGINE] 
+setting must be set to `YES` (of course, calls to the php search script will be hijacked by this plugin, 
+so you don't need to bother to install/configure php ;) ).
+----
 
 == Wiki Macros ==