Changes between Version 34 and Version 35 of DoxygenPlugin

Timestamp:

Sep 5, 2006, 11:52:20 AM (18 years ago)

Author:

Christian Boos

Comment:

Document upcoming html_output setting

DoxygenPlugin

@@ -67 +67 @@
 There's only one mandatory setting, it's the `path` to the generated documentation.
 This should match the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_output_directory OUTPUT_DIRECTORY] 
-setting in the Doxyfile.
+setting in the Doxyfile (if that's a relative path, you'll need to prepend the current working directory used 
+when running `doxygen`).
+
+Note that there's also the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_output HTML_OUTPUT] 
+setting which might play a role here. By default, the value for this setting is `html`, and this will be 
+appended to the path specified in `OUTPUT_DIRECTORY`. 
+
+'''Example:''' [[br]]
+{{{
+[doxygen]
+path = /var/cache/doxygen/myproject
+html_output = html
+}}}
 
 ==== Settings for Multiple Documentation Projects ====
@@ -77 +89 @@
 '''Example:''' [[br]]
 Let's imagine you have two sets of documentation, one for the latest trunk, one for a stable branch, 
-and they are generated at the following locations:
- - /var/cache/doxygen/devel
- - /var/cache/doxygen/stable
+and they are like this:
+{{{
+$ cd /var/cache/doxygen
+$ grep OUTPUT Doxyfile.stable
+OUTPUT_DIRECTORY = stable
+HTML_OUTPUT = html
+$ grep OUTPUT Doxygen.devel
+OUTPUT_DIRECTORY = devel
+HTML_OUTPUT = html
+$ doxygen Doxyfile.stable
+...
+$ doxygen Doxyfile.devel
+...
+}}}
+
+Now, you will have the following directory structure:
+ - /var/cache/doxygen/stable/html
+ - /var/cache/doxygen/devel/html
 
 You want to have links like `doxygen:MyClass` refer to the documentation for the ''stable'' branch,
 i.e. to be equivalent to `doxygen:stable/MyClass`.
+To that end, you need the following setup:
 
 {{{
@@ -89 +117 @@
 default_documentation = stable
 wiki_index = DoxyGen
+html_output = html
 }}}