nl.toolforge.karma.core.cmd.impl
Class DocModule

java.lang.Object
  nl.toolforge.karma.core.cmd.DefaultCommand
      nl.toolforge.karma.core.cmd.impl.AbstractBuildCommand
          nl.toolforge.karma.core.cmd.impl.DocModule

All Implemented Interfaces:

Command

public class DocModule

extends AbstractBuildCommand

Generates Javadoc API documentation for the given module.

Version:

$Id: DocModule.java,v 1.9 2004/11/02 23:57:06 asmedes Exp $

Author:

W.H. Schraal, D.A. Smedes

Field Summary

protected CommandResponse

response

Fields inherited from class nl.toolforge.karma.core.cmd.impl.AbstractBuildCommand

module

Constructor Summary

DocModule(CommandDescriptor descriptor)

Method Summary

void	execute() Executes the command.
CommandResponse	getCommandResponse() Return the specific CommandResponse object that this command uses.
protected java.io.File	getSourceDirectory()

Methods inherited from class nl.toolforge.karma.core.cmd.impl.AbstractBuildCommand

cleanUp, executeDelete, executeDelete, executeMkdir, getAntProject, getBuildEnvironment, getCompileDirectory, getCurrentManifest, getCurrentModule, getProjectInstance

Methods inherited from class nl.toolforge.karma.core.cmd.DefaultCommand

deregisterCommandResponseListener, getAlias, getCommandLine, getContext, getDescription, getFrontendMessages, getHelp, getName, getResponseListener, getWorkingContext, registerCommandResponseListener, setCommandLine, setContext

Methods inherited from class java.lang.Object

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

Field Detail

response

protected CommandResponse response

Constructor Detail

DocModule

public DocModule(CommandDescriptor descriptor)

Method Detail

execute

public void execute()
             throws CommandException

Description copied from interface: Command

Executes the command.

Specified by:

execute in interface Command

Overrides:

execute in class AbstractBuildCommand

Throws:

CommandException - When the module doesn't have a src/java or when no source files are available.

getCommandResponse

public CommandResponse getCommandResponse()

Description copied from interface: Command

Return the specific CommandResponse object that this command uses.

Returns:

CommandResponse

getSourceDirectory

protected java.io.File getSourceDirectory()
                                   throws ManifestException

Throws:

ManifestException