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

java.lang.Object
  nl.toolforge.karma.core.cmd.DefaultCommand
      nl.toolforge.karma.core.cmd.impl.DocAllModules

All Implemented Interfaces:

Command

public class DocAllModules

extends DefaultCommand

Generates API documentation for all modules.

Author:

W.H. Schraal, D.A. Schraal

Constructor Summary

DocAllModules(CommandDescriptor descriptor)

Method Summary

void	execute() Executes the command.
CommandResponse	getCommandResponse() Return the specific CommandResponse object that this command uses.

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

cleanUp, 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

Constructor Detail

DocAllModules

public DocAllModules(CommandDescriptor descriptor)

Method Detail

execute

public void execute()
             throws CommandException

Description copied from interface: Command

Executes the command.

Throws:

CommandException - When execution failed. This exception catches all underlying exceptions and rethrows them as a CommandException, except for RuntimeExceptions.

getCommandResponse

public CommandResponse getCommandResponse()

Description copied from interface: Command

Return the specific CommandResponse object that this command uses.

Returns:

CommandResponse