文档生成已禁用

时间:2014-12-23 14:36:38

标签: doxygen sonarqube

我做了教程中指定的所有内容 - Doxygen Plugin
这是sonarqube-4.5.1/conf/sonar.propeties文件doxygen条目:

# Doxygen
sonar.doxygen.generateDocumentation=enable
sonar.doxygen.deploymentPath=D:\Downloads\sonarqube-4.5.1\web
sonar.doxygen.deploymentUrl=http://localhost:9000/sonar/documentation

sonarqube跑者的输出:

16:07:16.265 INFO  - ANALYSIS SUCCESSFUL
16:07:16.266 DEBUG - Post-jobs : org.sonar.plugins.doxygen.DoxygenPostJob@28bda649
16:07:16.266 INFO  - Executing post-job class org.sonar.plugins.doxygen.DoxygenPostJob
16:07:16.271 INFO  - === SUPPRESS PREVIOUS GENERATION ===
16:07:16.395 INFO  - === DOXYGEN EXECUTION ===
16:07:16.396 INFO  - ### Generating configuration ###
16:07:16.427 INFO  - ### Generating documentation ###

此外,在指定的\web文件夹中,有一个documentation文件夹似乎包含正确的doxygen文档输出。

然而,我一直在SonarQube网络界面中收到此Documentation Generation is disabled.消息:

enter image description here

更新

这是我的sonar-project.properties文件现在包含的内容 - 使用unix样式的路径:

#Doxygen
sonar.doxygen.generateDocumentation=enable
sonar.doxygen.deploymentPath=/Downloads/sonarqube-4.5.1/web
sonar.doxygen.deploymentUrl=http://localhost:9000/sonar/documentation

输出保持不变,同样的问题。


要在Web服务器界面中查看文档,我需要做什么?
这似乎是服务器链接问题,因为正确生成了文档,位于以下位置:/Downloads/sonarqube-4.5.1/web/documentation

我也发现了这个内容:

core,true,sonar-core-plugin-4.5.1.jar|9289fc1067c31372c0b020aa01163087
emailnotifications,true,sonar-email-notifications-plugin-4.5.1.jar|bb35818e4a655a3ba2cff2afc65a296b
findbugs,false,sonar-findbugs-plugin-2.4.jar|bb0bf263ef1e0d56f569878732060cc9
java,false,sonar-java-plugin-2.4.jar|a105d018165ddeb2c0f5074100768660
cpd,true,sonar-cpd-plugin-4.5.1.jar|e11ff5066c9e2308036838510d87a6fe
dbcleaner,true,sonar-dbcleaner-plugin-4.5.1.jar|a444b3b4571791e1cde146ffa5132ee4
design,true,sonar-design-plugin-4.5.1.jar|0c6476994a44904307cfa8b8a08bbddd
doxygen,false,sonar-doxygen-plugin-0.1.jar|d86e1ab81c3ac34e6b31aa1da28d7f72
l10nen,true,sonar-l10n-en-plugin-4.5.1.jar|c21d53f67901cf6df3da1b4dd48a441b
sonarqube-4.5.1\web\deploy\plugins\index.txt中的

。 看起来doxygen与false相关联。如果我尝试编辑它(到true)并重新启动服务器没有任何变化。该文件被声纳 - 跑步者覆盖。

2 个答案:

答案 0 :(得分:2)

sonar.doxygen.generateDocumentation是项目属性,而不是服务器属性。你必须在" sonar-project.properties"中设置它。如果您使用SonarQube Runner运行分析,或者如果您使用Maven运行分析,则在pom.xml文件中运行。

答案 1 :(得分:1)

以下是我解决这个问题的方法:

  1. 停止了sonar-qube服务器。

  2. 使用更新的doxygen插件sonar-doxygen-plugin-0.1.jar替换/Downloads/sonarqube-4.5.1/extensions/plugins中的旧https://github.com/SonarCommunity/sonar-doxygen/releases/download/1.0/sonar-doxygen-plugin-1.0-SNAPSHOT.jar

  3. 从项目sonar-project.properties文件中删除了doxygen的旧配置条目。并将其替换为以下条目:

    sonar.doxygen.url=http://localhost:8000/
    sonar.doxygen.enable=true
    
  4. 使用简单的python script在该服务器上发布文档html(http://localhost:8000/)。

  5. 重新启动sonar-qube服务器。

  6. 再次运行sonar-runner.bat

  7. 现在文档就位。