Modifier and Type | Method and Description |
---|---|
java.lang.String |
JavaDocEncoder.encode(IDocRoot doc) |
Modifier and Type | Method and Description |
---|---|
IDocRoot |
ICompound.briefDescription()
Returns a tree-structured representation of the brief
description that is attached to this compound.
|
IDocRoot |
IMember.briefDescription() |
IDocRoot |
IParam.briefDescription() |
IDocRoot |
IDocumentedElement.briefDescription()
provides the brief description for this element.
|
IDocRoot |
ISection.description()
Returns the description attached to this section (for user defined
sections, also known as member groups).
|
IDocRoot |
ICompound.detailedDescription()
Returns a tree-structured representation of the detailed
description that is attached to this compound.
|
IDocRoot |
IMember.detailedDescription() |
IDocRoot |
IDocumentedElement.detailedDescription()
provides the detailed description for this element.
|
IDocRoot |
IMember.inbodyDescription() |
Modifier and Type | Method and Description |
---|---|
IDocRoot |
CompoundHandler.briefDescription() |
IDocRoot |
CompoundHandler.detailedDescription() |
Modifier and Type | Class and Description |
---|---|
class |
DocHandler
\brief Node representing a documentation block.
|
Modifier and Type | Method and Description |
---|---|
IDocRoot |
MemberHandler.briefDescription() |
IDocRoot |
MemberHandler.detailedDescription() |
IDocRoot |
MemberHandler.inbodyDescription() |
Modifier and Type | Method and Description |
---|---|
IDocRoot |
ParamHandler.briefDescription() |
Modifier and Type | Method and Description |
---|---|
IDocRoot |
SectionHandler.description() |