org.codehaus.enunciate.modules
Interface DocumentationAwareModule

All Superinterfaces:

DeploymentModule, ProjectTitleAware

All Known Implementing Classes:

DocumentationDeploymentModule

public interface DocumentationAwareModule
extends ProjectTitleAware

Author:

Ryan Heaton

Method Summary

java.lang.String	getDocsDir() The subdirectory in the web application where the documentation will be put.
java.lang.String	getIndexPageName() The name of the index page.
java.lang.String	getTitle() The title of the documentation.
void	setDocsDir(java.lang.String docsDir) The subdirectory in the web application where the documentation will be put.
void	setIndexPageName(java.lang.String indexPageName) The name of the index page.
void	setTitle(java.lang.String title) The title of the documentation.

Methods inherited from interface org.codehaus.enunciate.modules.ProjectTitleAware

setTitleConditionally

Methods inherited from interface org.codehaus.enunciate.modules.DeploymentModule

close, getAliases, getConfigurationRules, getName, getOrder, getValidator, init, isDisabled, step

Method Detail

getTitle

java.lang.String getTitle()

The title of the documentation.

Returns:

The title of the documentation.

setTitle

void setTitle(java.lang.String title)

The title of the documentation.

Parameters:

title - The title of the documentation.

getDocsDir

java.lang.String getDocsDir()

The subdirectory in the web application where the documentation will be put.

Returns:

The subdirectory in the web application where the documentation will be put.

setDocsDir

void setDocsDir(java.lang.String docsDir)

The subdirectory in the web application where the documentation will be put.

Parameters:

docsDir - The subdirectory in the web application where the documentation will be put.

getIndexPageName

java.lang.String getIndexPageName()

The name of the index page.

Returns:

The name of the index page.

setIndexPageName

void setIndexPageName(java.lang.String indexPageName)

The name of the index page.

Parameters:

indexPageName - The name of the index page.