Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

As the documentation is generated in HTML, it is necessary to make it accessible from an URL.

Sonar server SonarQube server can be used but it is not recommended as it may affect Sonar performancesSonarQube performances. 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.

...

 Property NameMandatoryComments
sonar.doxygen.deploymentPathDocumentation Path GenerationYESDirectory path where the documentation will be generated.
If Sonar SonarQube server is used to access the documentation, the path should be set to: <sonar.install.dir>/war/sonar-server.
sonar.doxygen.deploymentUrlWeb Server Deployment URLYES

URL to display the generated documentation.
Sonar SonarQube server can be used to access the documentation.

sonar.doxygen.customPathDirectory Path containing header.html, footer.html and doxygen.css NOIn order to customize HTML documentation.

...

 Property NameMandatoryComments Default Value
sonar.doxygen.generateDocumentationGenerate Doxygen DocumentationNO

Possible values:

  • disable: do not generate documentation and delete existing documentation.
  • keep: do not generate documentation but keep previous documentation if existing.
  • enable: generate or regenerate documentation
disable 
sonar.doxygen.excludeFiles

Excludes Specific Files

NOComa separated list 
sonar.doxygen.generateClassGraphs

Generates Class Graphs

NO

If the property is set to true, graphviz must be installed.

false
sonar.doxygen.generateCallGraphsGenerates Call GraphsNO

If the property is set to true, graphviz must be installed.

false
sonar.doxygen.generateCallerGraphsGenerates Caller GraphsNO

If the property is set to true, graphviz must be installed.

false

Requirements

Plugin

0.1

Doxygen

 1.7.5

Graphviz

 2.28

Usage & Installation

  1. Install the following tools (standard installation):

  2. 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.
  3. Stop Sonar serverSonarQube server.
  4. Copy the JAR file to the <sonar.install.dir>/extensions/plugins/ directory.
  5. Restart Sonar SonarQube server.
  6. 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.

...

JIRA Issues
anonymoustrue
titleRelease 0.1
height100
renderModestatic
width900
columnstype,;key,;summary,;priority,;status,;resolution
urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery=project+%3D+SONARPLUGINS+AND+fixVersion+%3D+%22DOXYGEN-0.1%22+AND+status+%3D+Resolved+ORDER+BY+priority+fixfor=18763&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000