Description / Features
This plugin generates the documentation of the application using Doxygen and Graphviz. To generate graphs, Graphviz must be installed.
This generated documentation can be browse through the Documentation item on the left menu or from the Documentation tab at file level.
- The Documentation item is available at project level (project, module and package). Different pages of documentation are displayed according to the level of the current dashboard:
- At project or module level: the main page of the documentation is displayed.
- At package level: the main page of the package documentation is displayed.
- From there, it is then possible to navigate through the whole documentation.
- The Documentation tab displays the documentation associated to the current class.
- From there, it is then possible to navigate through the whole documentation.
As the documentation is generated in HTML, it is necessary to make it accessible from an URL.
SonarQubeserver can be used but it is not recommended as it may affect SonarQubeperformances. To configure it that way, set Web Server Deployment URL to http://localhost:9000 (may be different according to your configuration) and Documentation Path Generation to <sonar.install.dir>/war/sonar-server.
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 http://localhost:80 (may be different according to your configuration) and Documentation Path Generation to <apache.install.dir>/www.
Global Properties
| Property Name | Mandatory | Comments | |
|---|---|---|---|
| sonar.doxygen.deploymentPath | Documentation Path Generation | YES | Directory path where the documentation will be generated. If SonarQube server is used to access the documentation, the path should be set to: <sonar.install.dir>/war/sonar-server. |
| sonar.doxygen.deploymentUrl | Web Server Deployment URL | YES | URL to display the generated documentation. |
| sonar.doxygen.customPath | Directory Path containing header.html, footer.html and doxygen.css | NO | In order to customize HTML documentation. |
Project Properties
| Property Name | Mandatory | Comments | Default Value | |
|---|---|---|---|---|
| sonar.doxygen.generateDocumentation | Generate Doxygen Documentation | NO | Possible values:
| disable |
| sonar.doxygen.excludeFiles | Excludes Specific Files | NO | Coma separated list | |
| sonar.doxygen.generateClassGraphs | Generates Class Graphs | NO | If the property is set to true, graphviz must be installed. | false |
| sonar.doxygen.generateCallGraphs | Generates Call Graphs | NO | If the property is set to true, graphviz must be installed. | false |
| sonar.doxygen.generateCallerGraphs | Generates Caller Graphs | NO | If the property is set to true, graphviz must be installed. | false |
Usage & Installation
Install the following tools (standard installation):
Software Download URL Doxygen http://www.stack.nl/~dimitri/doxygen/download.html Graphviz http://www.graphviz.org/Download.php - Add the directories <doxygen.install.dir>/bin and <graphviz.install.dir>/bin as Path Environment Variables. Commands doxygen, dot, etc... must be recognized by the system.
- Stop SonarQubeserver.
- Copy the JAR file to the <sonar.install.dir>/extensions/plugins/ directory.
- Restart SonarQube server.
- Configure the plugin at global level and for each project.
Compatibility Matrix
Plugin | 0.1 |
|---|---|
Doxygen | 1.7.5 |
Graphviz | 2.28 |
Known Limitations
This first version is limited to Java.
Change Log
| Release 0.1 (1 issues) | |||||
|---|---|---|---|---|---|
| Type | Key | Summary | Priority | Status | Resolution |
|
SONARPLUGINS-1673 | Initialization of Doxygen Plugin |
|
 Closed
|
Fixed |
Labels
