Changes between Version 34 and Version 35 of DoxygenPlugin
- Timestamp:
- Sep 5, 2006, 11:52:20 AM (18 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DoxygenPlugin
v34 v35 67 67 There's only one mandatory setting, it's the `path` to the generated documentation. 68 68 This should match the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_output_directory OUTPUT_DIRECTORY] 69 setting in the Doxyfile. 69 setting in the Doxyfile (if that's a relative path, you'll need to prepend the current working directory used 70 when running `doxygen`). 71 72 Note that there's also the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_output HTML_OUTPUT] 73 setting which might play a role here. By default, the value for this setting is `html`, and this will be 74 appended to the path specified in `OUTPUT_DIRECTORY`. 75 76 '''Example:''' [[br]] 77 {{{ 78 [doxygen] 79 path = /var/cache/doxygen/myproject 80 html_output = html 81 }}} 70 82 71 83 ==== Settings for Multiple Documentation Projects ==== … … 77 89 '''Example:''' [[br]] 78 90 Let's imagine you have two sets of documentation, one for the latest trunk, one for a stable branch, 79 and they are generated at the following locations: 80 - /var/cache/doxygen/devel 81 - /var/cache/doxygen/stable 91 and they are like this: 92 {{{ 93 $ cd /var/cache/doxygen 94 $ grep OUTPUT Doxyfile.stable 95 OUTPUT_DIRECTORY = stable 96 HTML_OUTPUT = html 97 $ grep OUTPUT Doxygen.devel 98 OUTPUT_DIRECTORY = devel 99 HTML_OUTPUT = html 100 $ doxygen Doxyfile.stable 101 ... 102 $ doxygen Doxyfile.devel 103 ... 104 }}} 105 106 Now, you will have the following directory structure: 107 - /var/cache/doxygen/stable/html 108 - /var/cache/doxygen/devel/html 82 109 83 110 You want to have links like `doxygen:MyClass` refer to the documentation for the ''stable'' branch, 84 111 i.e. to be equivalent to `doxygen:stable/MyClass`. 112 To that end, you need the following setup: 85 113 86 114 {{{ … … 89 117 default_documentation = stable 90 118 wiki_index = DoxyGen 119 html_output = html 91 120 }}} 92 121