hudson.plugins.doxygen

Class DoxygenArchiver

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

hudson.plugins.doxygen.DoxygenArchiver

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.matrix.MatrixAggregatable, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep, Serializable

public class DoxygenArchiver
extends hudson.tasks.Recorder
implements Serializable, hudson.matrix.MatrixAggregatable

Author:

Gregory Boissinot

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DoxygenArchiver.BaseDoxygenAction
static class	DoxygenArchiver.DoxygenAction
static class	DoxygenArchiver.DoxygenArchiverDescriptor
static class	DoxygenArchiver.DoxygenBuildAction

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
static DoxygenArchiver.DoxygenArchiverDescriptor	DESCRIPTOR
String	folderWhereYouRunDoxygen
String	runOnChild

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
DoxygenArchiver(String doxyfilePath, boolean keepAll, String runOnChild, String folderWhereYouRunDoxygen)

Method Summary

Methods

Modifier and Type	Method and Description
hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
DoxygenArchiver.DoxygenArchiverDescriptor	getDescriptor()
String	getDoxyfilePath()
String	getDoxygenHtmlDirectory() Deprecated.
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
String	getPublishType() Deprecated.
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
boolean	isKeepAll()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
boolean	prebuild(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectActions, perform

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectActions

Field Detail

DESCRIPTOR

@Extension
public static final DoxygenArchiver.DoxygenArchiverDescriptor DESCRIPTOR

runOnChild

public String runOnChild

folderWhereYouRunDoxygen

public String folderWhereYouRunDoxygen

Constructor Detail

DoxygenArchiver

@DataBoundConstructor
public DoxygenArchiver(String doxyfilePath,
                                    boolean keepAll,
                                    String runOnChild,
                                    String folderWhereYouRunDoxygen)

Method Detail

getDoxyfilePath

public String getDoxyfilePath()

isKeepAll

public boolean isKeepAll()

getPublishType

@Deprecated
public String getPublishType()

Deprecated.

getDoxygenHtmlDirectory

@Deprecated
public String getDoxygenHtmlDirectory()

Deprecated.

prebuild

public boolean prebuild(hudson.model.AbstractBuild<?,?> build,
               hudson.model.BuildListener listener)

Specified by:

prebuild in interface hudson.tasks.BuildStep

Overrides:

prebuild in class hudson.tasks.BuildStepCompatibilityLayer

perform

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

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

getDescriptor

public DoxygenArchiver.DoxygenArchiverDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Recorder

getProjectAction

public hudson.model.Action getProjectAction(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer

createAggregator

public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild build,
                                              hudson.Launcher launcher,
                                              hudson.model.BuildListener listener)

Specified by:

createAggregator in interface hudson.matrix.MatrixAggregatable