Changes between Version 30 and Version 31 of DoxygenPlugin


Ignore:
Timestamp:
Sep 5, 2006, 11:29:17 AM (8 years ago)
Author:
cboos
Comment:

Improve section about Doxygen configuration

Legend:

Unmodified
Added
Removed
Modified
  • DoxygenPlugin

    v30 v31  
    4141
    4242== Example ==
    43 
     43----
    4444=== Installation ===
    4545
     
    125125=== Configuring Doxygen ===
    126126
    127 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.
     127The only configuration setting in the Doxyfile that is required to make this plugin work is
     128[http://www.stack.nl/~dimitri/doxygen/config.html#cfg_generate_html GENERATE_HTML].
     129{{{
     130#!comment
     131GENERATE_TREEVIEW doesn't seem to be needed... Why was this part of the mandatory settings?
     132}}}
     133
     134Since 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.
    128135
    129136{{{
     
    131138HTML_FOOTER            = TracFooter.html
    132139}}}
     140See [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_header HTML_HEADER]
     141and [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_footer HTML_FOOTER].
    133142
    134143These 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:
     
    138147</style>
    139148}}}
    140 
    141149and my !TracFooter.html contains a blank line.
    142150
    143 To enable the search option the {{{SEARCHENGINE}}} tag must be set to 'YES'.
     151To enable the search option, the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_searchengine SEARCHENGINE]
     152setting must be set to `YES` (of course, calls to the php search script will be hijacked by this plugin,
     153so you don't need to bother to install/configure php ;) ).
     154----
    144155
    145156== Wiki Macros ==