Changes between Version 34 and Version 35 of DoxygenPlugin


Ignore:
Timestamp:
Sep 5, 2006, 1:52:20 PM (10 years ago)
Author:
cboos
Comment:

Document upcoming html_output setting

Legend:

Unmodified
Added
Removed
Modified
  • DoxygenPlugin

    v34 v35  
    6767There's only one mandatory setting, it's the `path` to the generated documentation.
    6868This should match the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_output_directory OUTPUT_DIRECTORY]
    69 setting in the Doxyfile.
     69setting in the Doxyfile (if that's a relative path, you'll need to prepend the current working directory used
     70when running `doxygen`).
     71
     72Note that there's also the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_output HTML_OUTPUT]
     73setting which might play a role here. By default, the value for this setting is `html`, and this will be
     74appended to the path specified in `OUTPUT_DIRECTORY`.
     75
     76'''Example:''' [[br]]
     77{{{
     78[doxygen]
     79path = /var/cache/doxygen/myproject
     80html_output = html
     81}}}
    7082
    7183==== Settings for Multiple Documentation Projects ====
     
    7789'''Example:''' [[br]]
    7890Let'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
     91and they are like this:
     92{{{
     93$ cd /var/cache/doxygen
     94$ grep OUTPUT Doxyfile.stable
     95OUTPUT_DIRECTORY = stable
     96HTML_OUTPUT = html
     97$ grep OUTPUT Doxygen.devel
     98OUTPUT_DIRECTORY = devel
     99HTML_OUTPUT = html
     100$ doxygen Doxyfile.stable
     101...
     102$ doxygen Doxyfile.devel
     103...
     104}}}
     105
     106Now, you will have the following directory structure:
     107 - /var/cache/doxygen/stable/html
     108 - /var/cache/doxygen/devel/html
    82109
    83110You want to have links like `doxygen:MyClass` refer to the documentation for the ''stable'' branch,
    84111i.e. to be equivalent to `doxygen:stable/MyClass`.
     112To that end, you need the following setup:
    85113
    86114{{{
     
    89117default_documentation = stable
    90118wiki_index = DoxyGen
     119html_output = html
    91120}}}
    92121