org.apache.maven.doxia.parser.module

Interface ParserModule

All Known Implementing Classes:

AbstractParserModule

public interface ParserModule

Provides definitions for a Doxia Parser module. This is used by the Doxia Site Tools to find which Doxia modules can parse files, and where to find these files by default (directory and extension).

Since:

1.6

Method Summary

Methods

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

Method Detail

getSourceDirectory

String getSourceDirectory()

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

Returns:

The source directory.

getExtension

String getExtension()

Returns the default file extension for a given module.

Returns:

The default file extension.

getParserId

String getParserId()

Returns the parser id for a given module.

Returns:

The parser id.