sfi.director.application.autodoc.DocCategory Class Reference

Category information. More...

Public Member Functions
	DocCategory ()
	DocCategory (DBObject catdbo, String audience)
String	name ()
	Accessor for attribute name.
String	name (String name)
	Mutator for attribute name.
String	subtitle ()
	Accessor for attribute title.
String	subtitle (String subtitle)
	Mutator for attribute title.
int	detaillevel ()
	Accessor for attribute detaillevel.
int	detaillevel (int detaillevel)
	Mutator for attribute detaillevel.

Static Public Member Functions
static DocCategory	getCategoryFor (DBObject dbo, String audience) throws DirectorException
	get the category associated with the given object.

Protected Attributes
String	name = null
String	subtitle = null
	Sub paragraph this object should appear in.
int	detaillevel = 3

Detailed Description

Category information.

Constructor & Destructor Documentation

sfi.director.application.autodoc.DocCategory.DocCategory

(

)

Referenced by sfi.director.application.autodoc.DocCategory.getCategoryFor().

sfi.director.application.autodoc.DocCategory.DocCategory	(	DBObject	catdbo,
		String	audience
	)

References sfi.director.application.autodoc.DocCategory.detaillevel(), sfi.director.repository.DBObject.getAttribute(), sfi.director.repository.DBObject.getValue(), sfi.director.application.autodoc.DocCategory.name(), and sfi.director.application.autodoc.DocCategory.subtitle().

Member Function Documentation

int sfi.director.application.autodoc.DocCategory.detaillevel

(

)

Accessor for attribute detaillevel.

Referenced by sfi.director.application.autodoc.DocCategory.detaillevel(), and sfi.director.application.autodoc.DocCategory.DocCategory().

int sfi.director.application.autodoc.DocCategory.detaillevel

(

int

detaillevel

)

Mutator for attribute detaillevel.

References sfi.director.application.autodoc.DocCategory.detaillevel().

static DocCategory sfi.director.application.autodoc.DocCategory.getCategoryFor ( DBObject  dbo, String  audience  ) throws DirectorException

static

get the category associated with the given object.

References sfi.director.application.autodoc.DocCategory.DocCategory(), sfi.director.repository.config.DirectoryAccess.get(), and sfi.director.repository.config.Directory.getDirectory().

Referenced by sfi.director.application.autodoc.DocBuilder.domaindoc(), sfi.director.application.autodoc.DocBuilder.genericObjDoc(), sfi.director.application.autodoc.DocBuilder.hostdoc(), sfi.director.application.autodoc.DocBuilder.locationdoc(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

String sfi.director.application.autodoc.DocCategory.name

(

)

Accessor for attribute name.

Referenced by sfi.director.application.autodoc.DocCategory.DocCategory(), and sfi.director.application.autodoc.DocCategory.name().

String sfi.director.application.autodoc.DocCategory.name

(

String

name

)

Mutator for attribute name.

References sfi.director.application.autodoc.DocCategory.name().

String sfi.director.application.autodoc.DocCategory.subtitle

(

)

Accessor for attribute title.

Referenced by sfi.director.application.autodoc.DocCategory.DocCategory(), and sfi.director.application.autodoc.DocCategory.subtitle().

String sfi.director.application.autodoc.DocCategory.subtitle

(

String

subtitle

)

Mutator for attribute title.

References sfi.director.application.autodoc.DocCategory.subtitle().

Member Data Documentation

int sfi.director.application.autodoc.DocCategory.detaillevel = 3

protected

Referenced by sfi.director.application.autodoc.DocBuilder.domaindoc(), sfi.director.application.autodoc.DocBuilder.genericObjDoc(), sfi.director.application.autodoc.DocBuilder.hostdoc(), sfi.director.application.autodoc.DocBuilder.locationdoc(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

String sfi.director.application.autodoc.DocCategory.name = null

protected

String sfi.director.application.autodoc.DocCategory.subtitle = null

protected

Sub paragraph this object should appear in.

Referenced by sfi.director.application.autodoc.DocBuilder.hostdoc(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

---

The documentation for this class was generated from the following file:

• director/src/sfi/director/application/autodoc/DocCategory.java