![]() To make this plugin work, you have to set to YES the following items in the Doxyfile: doxygentrac.* = enabled Configuring Doxygen If you install the plugin globally, you will also need to enable it in your trac.ini file: Idl odl java cs py php php4 inc phtml m cpp cxx c hpp hxx h Space separated list of source files extensions. Space separated list of extensions for Doxygen managed files. If set, supersedes the index option.ĭefault encoding used by the generated documentation files. Wiki page to use as the default page for the Doxygen main page. Index.html (main.html in versions <= 0.11) When no explicit path is given in a documentation request, this path will be used to find the searchdata_fileĭefault index page to pick in the generated documentation. (unavailable in versions <= 0.11)ĭefault documentation project, relative to path. The name of the file specified by the "SEARCHDATA_FILE" Doxygen configuration setting. This is usefull if you plan to include the doxyfile produced by the plugin from another file to override a few Doxygen options (unavailable in versions <= 0.11) (unavailable in versions <= 0.11)Īrgument of the Doxygen command. (unavailable in versions <= 0.11)įull path of the Doxygen command. (unavailable in versions <= 0.11)įull path of the Doxyfile to be created. Mostly useful for Doxygen EXCLUDE option. Title to use for the main navigation tab.ĭirectory containing the sources. These are all the configuration options recognized in the section of TracIni:ĭefault documentation project suffix, as generated by Doxygen using the HTML_OUTPUT Doxygen configuration setting. Documentation for the development documentation: Main page for the stable documentation: In this situation use the wiki_index, so you can place links to both documentation sets: path = /var/cache/doxygen default_documentation = stable wiki_index = DoxyGen html_output = html By default, the value for this setting is html, and this will be appended to the path specified in OUTPUT_DIRECTORY: Note that there is also the HTML_OUTPUT setting which might play a role here. Also, don't forget to grant the users the DOXYGEN_VIEW permission, else a blank page will be returned. If that is a relative path, you will need to prefix the current working directory used when running doxygen. This should match the OUTPUT_DIRECTORY setting in the Doxyfile. There is only one mandatory setting, which is the path to the generated documentation. Processing dependencies for TracDoxygen = 0.11.0.2Ī section should be created in TracIni. Installed /usr/local/lib/python2.6/dist-packages/TracDoxygen-0.11.0.2-py2.6.egg Running setup.py -q bdist_egg -dist-dir /tmp/easy_install-CIE2Es/0.11/egg-dist-tmp-88Ruf4Īdding TracDoxygen 0.11.0.2 to easy-install.pth file Note: the 0.10 branch of this plugin is deprecated and the 0.11 branch of this plugin is not maintained.Įxisting bugs and feature requests for DoxygenPlugin areĭoing subversion checkout from to /tmp/easy_install-CIE2Es/0.11 The trunk branch of this plugin is compatible with Trac >= 0.11 and Doxygen >= 1.8, and is the most recent version. links within that page.Ĭonfiguring the Doxygen plugin is straightforward if you have a Doxygen generated documentation ready and no other to use, and a bit more involved if you want to use all the features. ![]() That way you can build your own meta index the way you want, using doxygen. If you have to present only one documentation project, that index page can directly be a Doxygen-generated page, like the index.html (default), files.html etc.Īn alternative is to pick a Wiki page to use as the index, and this is indeed the best option if you have multiple documentation projects to serve. The plugin also provides a new main navigation tab, named Doxygen by default, which will present an index page. Submitting the form will archive the chosen options, and Doxygen will run immediately on them. The plugin provides a new link in the admin panel, which will present a web form version of the Doxygen standard configuration file, named Doxyfile by default. This plugin produces and embeds one or multiple Doxygen-generated documentation(s) within Trac, to have up-to-date documentation and easy referencing to Doxygen pages using the usual TracLinks and the doxygen: prefix. Settings for Multiple Documentation ProjectsĮmbed Doxygen-generated pages into Trac Description.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |