Add support for the Jenkins Doxygen publisher plugin.
Change-Id: I0e8f9ee13b7e6fb22e1a5e4bb613b44ae6927e86
This commit is contained in:
parent
e0549303e7
commit
e4c920833b
|
@ -3249,6 +3249,33 @@ def description_setter(parser, xml_parent, data):
|
||||||
XML.SubElement(descriptionsetter, 'setForMatrix').text = for_matrix
|
XML.SubElement(descriptionsetter, 'setForMatrix').text = for_matrix
|
||||||
|
|
||||||
|
|
||||||
|
def doxygen(parser, xml_parent, data):
|
||||||
|
"""yaml: doxygen
|
||||||
|
This plugin parses the Doxygen descriptor (Doxyfile) and provides a link to
|
||||||
|
the generated Doxygen documentation.
|
||||||
|
|
||||||
|
Requires the Jenkins `Doxygen Plugin.
|
||||||
|
<https://wiki.jenkins-ci.org/display/JENKINS/Doxygen+Plugin>`_
|
||||||
|
|
||||||
|
:arg str doxyfile: The doxyfile path
|
||||||
|
:arg bool keepall: Retain doxygen generation for each successful build
|
||||||
|
(default: false)
|
||||||
|
:arg str folder: Folder where you run doxygen (default: '')
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
.. literalinclude:: /../../tests/publishers/fixtures/doxygen001.yaml
|
||||||
|
|
||||||
|
"""
|
||||||
|
p = XML.SubElement(xml_parent, 'hudson.plugins.doxygen.DoxygenArchiver')
|
||||||
|
if not data['doxyfile']:
|
||||||
|
raise JenkinsJobsException("The path to a doxyfile must be specified.")
|
||||||
|
XML.SubElement(p, 'doxyfilePath').text = str(data.get("doxyfile"))
|
||||||
|
XML.SubElement(p, 'keepAll').text = str(data.get("keepall", False)).lower()
|
||||||
|
XML.SubElement(p, 'folderWhereYouRunDoxygen').text = \
|
||||||
|
str(data.get("folder", ""))
|
||||||
|
|
||||||
|
|
||||||
def sitemonitor(parser, xml_parent, data):
|
def sitemonitor(parser, xml_parent, data):
|
||||||
"""yaml: sitemonitor
|
"""yaml: sitemonitor
|
||||||
This plugin checks the availability of an url.
|
This plugin checks the availability of an url.
|
||||||
|
|
|
@ -110,6 +110,7 @@ jenkins_jobs.publishers =
|
||||||
coverage=jenkins_jobs.modules.publishers:coverage
|
coverage=jenkins_jobs.modules.publishers:coverage
|
||||||
cppcheck=jenkins_jobs.modules.publishers:cppcheck
|
cppcheck=jenkins_jobs.modules.publishers:cppcheck
|
||||||
description-setter=jenkins_jobs.modules.publishers:description_setter
|
description-setter=jenkins_jobs.modules.publishers:description_setter
|
||||||
|
doxygen=jenkins_jobs.modules.publishers:doxygen
|
||||||
email-ext=jenkins_jobs.modules.publishers:email_ext
|
email-ext=jenkins_jobs.modules.publishers:email_ext
|
||||||
email=jenkins_jobs.modules.publishers:email
|
email=jenkins_jobs.modules.publishers:email
|
||||||
emotional-jenkins=jenkins_jobs.modules.publishers:emotional_jenkins
|
emotional-jenkins=jenkins_jobs.modules.publishers:emotional_jenkins
|
||||||
|
|
|
@ -0,0 +1,10 @@
|
||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<project>
|
||||||
|
<publishers>
|
||||||
|
<hudson.plugins.doxygen.DoxygenArchiver>
|
||||||
|
<doxyfilePath>Doxyfile</doxyfilePath>
|
||||||
|
<keepAll>false</keepAll>
|
||||||
|
<folderWhereYouRunDoxygen>build</folderWhereYouRunDoxygen>
|
||||||
|
</hudson.plugins.doxygen.DoxygenArchiver>
|
||||||
|
</publishers>
|
||||||
|
</project>
|
|
@ -0,0 +1,5 @@
|
||||||
|
publishers:
|
||||||
|
- doxygen:
|
||||||
|
doxyfile: "Doxyfile"
|
||||||
|
keepall: false
|
||||||
|
folder: "build"
|
Loading…
Reference in New Issue