public interface ICompound extends IDocumentedElement
Modifier and Type | Interface and Description |
---|---|
static class |
ICompound.CompoundKind
Represents the kind of compounds recognised by doxygen.
|
Modifier and Type | Method and Description |
---|---|
IDocRoot |
briefDescription()
Returns a tree-structured representation of the brief
description that is attached to this compound.
|
IDocRoot |
detailedDescription()
Returns a tree-structured representation of the detailed
description that is attached to this compound.
|
java.lang.String |
id()
Returns the id of this compound.
|
ICompound.CompoundKind |
kind()
Returns the kind of compound.
|
java.lang.String |
kindString()
Returns a string representation of the compound kind.
|
IMember |
memberById(java.lang.String id)
Returns an public interface to a member given its id.
|
java.util.ListIterator<IMember> |
memberByName(java.lang.String name)
Returns a list of all members within the compound having a certain
name.
|
java.lang.String |
name()
Returns the name of this compound
|
java.util.ListIterator<IUserDefined> |
sections()
Returns an iterator for the different member sections in this
compound.
|
java.lang.String name()
java.lang.String id()
ICompound.CompoundKind kind()
java.lang.String kindString()
kind()
java.util.ListIterator<IUserDefined> sections()
IDocRoot briefDescription()
briefDescription
in interface IDocumentedElement
IDocRoot detailedDescription()
detailedDescription
in interface IDocumentedElement
IMember memberById(java.lang.String id)
id
- The member id.java.util.ListIterator<IMember> memberByName(java.lang.String name)
name
- The name of the member.