pt.lsts.neptus.doc

Interface DocumentationProvider

All Known Implementing Classes:

DocumentationWrapper

public interface DocumentationProvider

This Interface is provided by classes that provide documentation to the end-user

Author:

zp

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArticleTitle() Retrieve the title to be used in the article
java.lang.String	getDocumentationFile() Retrieve the name of the html file that provides documentation for this class
java.lang.String	getSectionName() Retrieve the name of the section this documentation belongs to

Method Detail

getSectionName

java.lang.String getSectionName()

Retrieve the name of the section this documentation belongs to

Returns:

The name of the section this documentation article belongs to

getArticleTitle

java.lang.String getArticleTitle()

Retrieve the title to be used in the article

Returns:

The name of this article

getDocumentationFile

java.lang.String getDocumentationFile()

Retrieve the name of the html file that provides documentation for this class

Returns:

The filename of the article (inside doc/manual) providing documentation for this class