Package hudson.plugins.doxygen

Class DoxygenArchiver

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

hudson.plugins.doxygen.DoxygenArchiver

All Implemented Interfaces:

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

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

Author:

Gregory Boissinot

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	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

Publisher.DescriptorExtensionListImpl

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

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

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

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

Method Summary

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

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(AbstractBuild<?,?> build,
                        BuildListener listener)

Specified by:

prebuild in interface BuildStep

Overrides:

prebuild in class BuildStepCompatibilityLayer

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

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

getDescriptor

public DoxygenArchiver.DoxygenArchiverDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Recorder

getProjectAction

public Action getProjectAction(AbstractProject<?,?> project)

Specified by:

getProjectAction in interface BuildStep

Overrides:

getProjectAction in class BuildStepCompatibilityLayer

createAggregator

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

Specified by:

createAggregator in interface hudson.matrix.MatrixAggregatable