Changes between Version 28 and Version 29 of DoxygenPlugin

Timestamp:

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

Author:

Christian Boos

Comment:

Improved section about configuration settings

DoxygenPlugin

@@ +1 @@
+[[PageOutline]]
 = Doxygen Plugin for Trac =
 
@@ -52 +53 @@
 
 === Configuring Trac ===
+==== Basic Configuration ====
+A `[doxygen]` section should be created in TracIni. 
+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.
 
-Set path where you have your doxygen documentations and specify what documentation or wiki page should be displayed as a index. Setting wiki_index variable has higher priority. You can create your own content using ![doxygen:<page_name>] macro on specified wiki page and so provide easy multiple documentation support.
+==== Settings for Multiple Documentation Projects ====
+
+In this case, the `path` option is used to set a common prefix, shared by all the generated documentations.
+You can also use `default_documentation` to specify which project should be used when no explicit path are
+given when requesting a documentation file, when using the `doxygen:` TracLinks.
+
+'''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
+
+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`.
 
 {{{
 [doxygen]
-path = <path_to_the_doxygen_documentation>
-index = <name_of_mainpage_file>
-wiki_index = <name_of_wiki_page>
+path = /var/cache/doxygen
+default_documentation = stable
+wiki_index = DoxyGen
 }}}
 
-Doxygen generated documentation cointains html, png and sometime other files. To tell plugin which file extentions can be handled put to ![doxygen] section in trac.ini this:
+It is advised to used the `wiki_index` in this situation, so you can place links to both documentation sets:
+{{{
+= Documentation generated by Doxygen =
 
-{{{
-[doxygen]
-ext = htm html png # Default values
+ - Documentation for the stable API: 
+   [doxygen:stable/hierarchy class hierarchy], [doxygen:stable/dirs directory hierarchy]
+ - Documentation for the trunk API: 
+   [doxygen:devel/hierarchy class hierarchy], [doxygen:devel/dirs directory hierarchy]
 }}}
+
+==== Options Summary ====
+
+These are all the configuration options recognized in the `[doxygen]` section of TracIni.
+|| '''''Option Name''''' || '''''Documentation''''' || '''''Default value''''' ||
+|| '''path''' || Directory containing doxygen generated files. || 
+|| title      || Title to use for the main navigation tab. || ''Doxygen'' ||
+|| ext        || Space separated list of extensions for doxygen managed files. || ''htm html png'' ||
+|| source_ext || Space separated list of source files extensions || ''idl odl java cs py php php4 inc phtml m cpp cxx c hpp hxx h'' ||
+|| default_documentation || Default documentation project, relative to [doxygen] path. When no explicit path is given in a documentation request, this path will be prepended to the request before looking for documentation files. || 
+|| index      || Default index page to pick in the generated documentation. || ''main.html'' ||
+|| wiki_index || Wiki page to use as the default page for the Doxygen main page. If set, supersedes the [doxygen] index option. || 
+|| encoding   || Default encoding used by the generated documentation files. || ''iso-8859-1'' ||
+^^''(the above is in sync with r1245''^^
+
+
 
 If you want to change main navigation menu button label put this to ![doxygen] section in trac.ini: