net.craftforge.essential.controller.phases
Class DocumentationPhase

java.lang.Object
  net.craftforge.essential.controller.phases.DocumentationPhase

All Implemented Interfaces:

Phase

public class DocumentationPhase
extends Object
implements Phase

Generates the documentation of the resource class and sets it as the result.

Since:

20.07.11

Author:

Christian Bick

Constructor Summary

DocumentationPhase(State state, Setup setup)
Creates a documentation phase from a controller state and setup.

Method Summary

void	run() Runs the phase.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationPhase

public DocumentationPhase(State state,
                          Setup setup)

Creates a documentation phase from a controller state and setup.

Parameters:

state - The controller state

setup - The controller setup

Method Detail

run

public void run()
         throws ControllerException

Runs the phase.

Specified by:

run in interface Phase

Throws:

ControllerException - Failed to run phase