Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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

...

  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 SonarQubeTM server.
  4. Copy the JAR file to the <sonar.install.dir>/extensions/plugins/ directory.
  5. Restart Sonar SonarQubeTM server.
  6. Configure the plugin at global level and for each project.

...