= 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=cboos 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 === 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:] macro on specified wiki page and so provide easy multiple documentation support. {{{ [doxygen] path = index = wiki_index = }}} 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: {{{ [doxygen] ext = htm html png # Default values }}} If you want to change main navigation menu button label put this to ![doxygen] section in trac.ini: {{{ [doxygen] title = Documentation }}} If you install the plugin globally, you'll also need to enable it in trac.ini as follows: {{{ [components] doxygentrac.* = enabled }}} === 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 need to define a custom header and footer even if it will be containing only blank line. {{{ 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. You can put there you own CSS style as in following example: {{{ }}} and my !TracFooter.html contains a blank line. To enable the search option the {{{SEARCHENGINE}}} tag must be set to 'YES'. == Wiki Macros == Using provided wiki macro you can make a link to doxygen documentation page wherever you want. Specified links are related to setted up doxygen path: {{{ [doxygen:main.html Documentation] # Simple documentation in doxygen path. [doxygen:FirstProject/main.html First] # Multiple documentation in separate [doxygen:SecondProject/main.html Second] # directories in doxygen path. }}} == Feedback == [[Poll(Are you using this plugin?; Yes, it's usefull.; No, it's useless.; No, I don't need it.)]] == Change Log == [[ChangeLog(/doxygenplugin, 5)]] == Author/Contributors == '''Author:''' [wiki:jparks] [[BR]] '''Contributors:''' Blackhex cboos