= Doxygen Plugin for Trac = == Description == Integrates [http://www.stack.nl/~dimitri/doxygen/ doxygen] documentation into Trac. == Bugs/Feature Requests == Existing bugs and feature requests for DoxygenPlugin are [report:9?COMPONENT=DoxygenPlugin here]. If you have any issues, create a [http://trac-hacks.org/newticket?component=DoxygenPlugin&owner=jparks new ticket]. == Download == Download the zipped source from [download:doxygenplugin here]. == Source == You can check out the source for DoxygenPlugin from Subversion at http://trac-hacks.org/svn/doxygenplugin. == Example == === Installation === Download the source code for the DoxygenPlugin from [download:doxygenplugin here] or checkout the source from the trac hacks subversion repository at: http://trac-hacks.org/svn/doxygenplugin. Change to the doxygenplugin/0.9 directory and run: {{{ python setup.py bdist_egg }}} This will generate a python egg in the dist directory. Copy the egg file into the trac/plugins directory and follow the Configuration steps outlined below. === Configuring Trac === The path to the documentation points to the directory, in which the '''main.html''' resides. {{{ [doxygen] path = }}} === Configuring Doxygen === 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 probably want to define a custom header and footer. {{{ HTML_HEADER = TracHeader.html HTML_FOOTER = TracFooter.html }}} These files must contain something, a blank line is sufficient, or doxygen will put in the defaults. My !TracHeader.html contains the following: {{{ }}} and my !TracFooter.html contains a blank line. To enable the search option the {{{SEARCHENGINE}}} tag must be set to 'YES'. == Author/Contributors == '''Author:''' [wiki:jparks] [[BR]] '''Contributors:''' [[TagIt(plugin,jparks,alpha,0.9)]]