org.apache.maven.doxia.module.site

Interface SiteModule

All Known Implementing Classes:

AbstractSiteModule

Deprecated.

use ParserModule

public interface SiteModule

Provides definitions for a Doxia module. This is used by the doxia site tools.

Since:

1.0

Version:

$Id: SiteModule.java 1546011 2013-11-27 12:18:20Z hboutemy $

Author:

Jason van Zyl

See Also:

ParserModule

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE Deprecated. The Plexus lookup role.

Method Summary

Methods

Modifier and Type	Method and Description
String	getExtension() Deprecated. Returns the default file extension for a given module.
String	getParserId() Deprecated. Returns the parser id for a given module.
String	getSourceDirectory() Deprecated. Returns the directory that contains source files for a given module.

Field Detail

ROLE

static final String ROLE

Deprecated.

The Plexus lookup role.

Method Detail

getSourceDirectory

String getSourceDirectory()

Deprecated.

Returns the directory that contains source files for a given module.

Returns:

The source directory.

getExtension

String getExtension()

Deprecated.

Returns the default file extension for a given module.

Returns:

The default file extension.

getParserId

String getParserId()

Deprecated.

Returns the parser id for a given module.

Returns:

The parser id.