Package hudson.plugins.doxygen

Class DoxygenBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

hudson.plugins.doxygen.DoxygenBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep

public class DoxygenBuilder
extends Builder

Implementation of the "Generate documentation using Doxygen" build step

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DoxygenBuilder.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
DoxygenBuilder(String doxyfilePath, String installationName, boolean continueOnBuildFailure, boolean unstableIfWarnings)

Method Summary

Modifier and Type	Method	Description
boolean	getContinueOnBuildFailure()
Descriptor<Builder>	getDescriptor()
String	getDoxyfilePath()
String	getInstallationName()
DoxygenInstallation	getSelectedInstallation()	Finds the doxygen installation to use for this build among all installations configured in the Jenkins administration
boolean	getUnstableIfWarnings()
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DoxygenBuilder

@DataBoundConstructor
public DoxygenBuilder(String doxyfilePath,
                      String installationName,
                      boolean continueOnBuildFailure,
                      boolean unstableIfWarnings)

Method Detail

getDoxyfilePath

public String getDoxyfilePath()

getInstallationName

public String getInstallationName()

getContinueOnBuildFailure

public boolean getContinueOnBuildFailure()

getUnstableIfWarnings

public boolean getUnstableIfWarnings()

getSelectedInstallation

public DoxygenInstallation getSelectedInstallation()

Finds the doxygen installation to use for this build among all installations configured in the Jenkins administration

Returns:

selected Doxygen installation

perform

public boolean perform(AbstractBuild<?,?> build,
                       Launcher launcher,
                       BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

getDescriptor

public Descriptor<Builder> getDescriptor()

Specified by:

getDescriptor in interface Describable<Builder>

Overrides:

getDescriptor in class Builder