DJDoc v.1.0.0b-1

net.sf.djdoc.bo
Interface Api

All Known Implementing Classes:
ApiEntity, ApiVO

public interface Api

The instances of the Api interface represent Java APIs documented with the Javadoc tool.


Method Summary
 java.lang.String getDescription()
          Getter method for this Api's description.
 java.lang.String getName()
          Getter method for this Api's name.
 java.lang.String getPath()
          Getter method for this Api's path.
 java.lang.String getStylesheetName()
          Getter method for this Api's stylesheet name.
 java.lang.String getTitle()
          Getter method for this Api's title.
 

Method Detail

getName

java.lang.String getName()
Getter method for this Api's name.

Returns:
The name of this Api

getDescription

java.lang.String getDescription()
Getter method for this Api's description.

Returns:
The description of this Api

getPath

java.lang.String getPath()
Getter method for this Api's path.

Returns:
The path of this Api

getTitle

java.lang.String getTitle()
Getter method for this Api's title.

Returns:
The title of this Api

getStylesheetName

java.lang.String getStylesheetName()
Getter method for this Api's stylesheet name.

Returns:
The stylesheet name of this Api

DJDoc v.1.0.0b-1