Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{iframe:src=http://update.sonarsource.org/plugins/doxygen-confluence.html|width=700|height=250|frameborder=0}
Your browser does not support iframes.
{iframe}

...

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

...