Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="wysiwyg-macro" data-macro-name="unmigrated-inline-wiki-markup" data-macro-parameters="atlassian-macro-output-type=BLOCK" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3VubWlncmF0ZWQtaW5saW5lLXdpa2ktbWFya3VwOmF0bGFzc2lhbi1tYWNyby1vdXRwdXQtdHlwZT1CTE9DS30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>{iframe:src=http://update.sonarsource.org/plugins/doxygen.html|width=700|height=250|frameborder=0}
Your browser does not support iframes.
{iframe}</pre></td></tr></table><h1>Description / Features</h1><p>This plugin generates the documentation of the application using Doxygen and Graphviz. To generate graphs, Graphviz must be installed.</p><p>This generated documentation can be browse through the <em>Documentation </em>item on the left menu or from the <em>Documentation </em>tab at file level.</p><ul><li>The <em>Documentation </em>item is available at project level (project, module and package). Different pages of documentation are displayed according to the level of the current dashboard:<ul><li>At project or module level: the main page of the documentation is displayed.</li><li>At package level: the main page of the package documentation is displayed.</li></ul></li><li>From there, it is then possible to navigate through the whole documentation.</li></ul><p style="margin-left: 30.0px;"><img class="confluence-embedded-image confluence-content-image-border" height="570" width="813" src="/download/attachments/231080048/DoxygenPage.PNG?version=1&amp;modificationDate=1369284907157" data-image-src="/download/attachments/231080048/DoxygenPage.PNG?version=1&amp;modificationDate=1369284907157" data-linked-resource-id="231375394" data-linked-resource-type="attachment" data-linked-resource-default-alias="DoxygenPage.PNG" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231080048" title="null > DoxygenPage.PNG" data-element-title="DoxygenPage.PNG"></p><p> </p><ul><li>The <em>Documentation</em> tab displays the documentation associated to the current class.</li><li>From there, it is then possible to navigate through the whole documentation.</li></ul><p style="margin-left: 30.0px;"> <img class="confluence-embedded-image confluence-content-image-border" height="519" width="969" src="/download/attachments/231080048/DoxygenTab.PNG?version=1&amp;modificationDate=1369284907141" data-image-src="/download/attachments/231080048/DoxygenTab.PNG?version=1&amp;modificationDate=1369284907141" data-linked-resource-id="231375393" data-linked-resource-type="attachment" data-linked-resource-default-alias="DoxygenTab.PNG" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231080048" title="null > DoxygenTab.PNG" data-element-title="DoxygenTab.PNG"></p><p>As the documentation is generated in HTML, it is necessary to make it accessible from an URL.</p><p>Sonar server can be used but it is not recommended as it may affect Sonar performances. To configure it that way, set Web Server Deployment URL to <a href="http://localhost:9000/">http://localhost:9000</a> (may be different according to your configuration) and Documentation Path Generation to &lt;sonar.install.dir&gt;/war/sonar-server.</p><p>As said before, it is recommended to deploy documentation on another web server. Apache could be used. In this way, set Server Deployment URL to <a href="http://localhost/">http://localhost:80</a> (may be different according to your configuration) and Documentation Path Generation to &lt;apache.install.dir&gt;/www.</p><h2>Global Properties</h2><table class="confluenceTable"><tbody><tr><th colspan="1" class="confluenceTh"> </th><th class="confluenceTh">Property Name</th><th class="confluenceTh">Mandatory</th><th class="confluenceTh">Comments</th></tr><tr><td colspan="1" class="confluenceTd"><span>sonar.doxygen.deploymentPath</span></td><td class="confluenceTd"><strong>Documentation Path Generation</strong></td><td style="text-align: center;" class="confluenceTd">YES</td><td class="confluenceTd">Directory path where the documentation will be generated.<br />If Sonar server is used to access the documentation, the path should be set to:<em> &lt;sonar.install.dir&gt;/war/sonar-server</em>.</td></tr><tr><td colspan="1" class="confluenceTd">sonar.doxygen.deploymentUrl</td><td class="confluenceTd"><strong>Web Server Deployment URL</strong></td><td style="text-align: center;" class="confluenceTd">YES</td><td class="confluenceTd"><p>URL to display the generated documentation.<br />Sonar server can be used to access the documentation.</p></td></tr><tr><td colspan="1" class="confluenceTd">sonar.doxygen.customPath</td><td class="confluenceTd"><strong>Directory Path containing header.html, footer.html and doxygen.css</strong></td><td style="text-align: center;" class="confluenceTd"> NO</td><td class="confluenceTd">In order to customize HTML documentation.</td></tr></tbody></table><h2><strong>Project Properties</strong></h2><table class="confluenceTable"><tbody><tr><th colspan="1" class="confluenceTh"> </th><th class="confluenceTh">Property Name</th><th class="confluenceTh">Mandatory</th><th class="confluenceTh">Comments</th><th class="confluenceTh"> Default Value</th></tr><tr><td colspan="1" class="confluenceTd">sonar.doxygen.generateDocumentation</td><td class="confluenceTd"><strong>Generate Doxygen Documentation</strong></td><td style="text-align: center;" class="confluenceTd">NO</td><td class="confluenceTd"><p class="marginbottom10">Possible values:</p><ul class="bullet"><li><em>disable</em>: do not generate documentation and delete existing documentation.</li><li><em>keep</em>: do not generate documentation but keep previous documentation if existing.</li><li><em>enable</em>: generate or regenerate documentation</li></ul></td><td style="text-align: center;" class="confluenceTd">disable </td></tr><tr><td colspan="1" class="confluenceTd">sonar.doxygen.excludeFiles</td><td class="confluenceTd"><p><strong>Excludes Specific Files</strong></p></td><td style="text-align: center;" class="confluenceTd">NO</td><td class="confluenceTd">Coma separated list</td><td class="confluenceTd"> </td></tr><tr><td colspan="1" class="confluenceTd">sonar.doxygen.generateClassGraphs</td><td class="confluenceTd"><p><strong>Generates Class Graphs</strong></p></td><td style="text-align: center;" class="confluenceTd">NO</td><td class="confluenceTd"><p>If the property is set to <em>true</em>, graphviz must be installed.</p></td><td style="text-align: center;" class="confluenceTd">false</td></tr><tr><td colspan="1" class="confluenceTd">sonar.doxygen.generateCallGraphs</td><td class="confluenceTd"><strong>Generates Call Graphs</strong></td><td style="text-align: center;" class="confluenceTd">NO</td><td class="confluenceTd"><p>If the property is set to <em>true</em>, graphviz must be installed.</p></td><td style="text-align: center;" class="confluenceTd">false</td></tr><tr><td colspan="1" class="confluenceTd">sonar.doxygen.generateCallerGraphs</td><td class="confluenceTd"><strong>Generates Caller Graphs</strong></td><td style="text-align: center;" class="confluenceTd">NO</td><td class="confluenceTd"><p>If the property is set to <em>true</em>, graphviz must be installed.</p></td><td style="text-align: center;" class="confluenceTd">false</td></tr></tbody></table><h1>Usage &amp; Installation</h1><ol><li><p>Install the following tools (standard installation):</p><table class="confluenceTable"><tbody><tr><th style="margin-left: auto;" class="confluenceTh">Software</th><th class="confluenceTh">Download URL</th></tr><tr><td class="confluenceTd">Doxygen</td><td class="confluenceTd"><a href="http://www.stack.nl/~dimitri/doxygen/download.html">http://www.stack.nl/~dimitri/doxygen/download.html</a></td></tr><tr><td class="confluenceTd">Graphviz </td><td class="confluenceTd"><a href="http://www.graphviz.org/Download.php">http://www.graphviz.org/Download.php</a></td></tr></tbody></table></li><li>Add the directories <strong>&lt;doxygen.install.dir&gt;/bin</strong> and <strong>&lt;graphviz.install.dir&gt;/bin </strong>as Path Environment Variables. Commands <em>doxygen</em>, <em>dot</em>, etc... must be recognized by the system.</li><li>Stop Sonar server.</li><li>Copy the JAR file to the <strong>&lt;sonar.install.dir&gt;/extensions/plugins/</strong> directory.</li><li>Restart Sonar server.</li><li>Configure the plugin at global level and for each project.</li></ol><h1>Compatibility Matrix</h1><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Plugin</p></th><td class="confluenceTd"><p style="text-align: center;"><strong>0.1</strong></p></td></tr><tr><th class="confluenceTh"><p>Doxygen</p></th><td class="confluenceTd"><p> 1.7.5</p></td></tr><tr><th class="confluenceTh"><p>Graphviz</p></th><td class="confluenceTd"><p> 2.28</p></td></tr></tbody></table><h1>Known Limitations</h1><p>This first version is limited to Java.</p><h1>Change Log</h1><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjF8aGVpZ2h0PTEwMHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5O3N0YXR1cztyZXNvbHV0aW9ufHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE4NzYzJnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9cHJpb3JpdHkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=100|renderMode=static|title=Release 0.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=18763&amp;pid\=11911&amp;sorter/field\=priority&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p>