Package org.cakelab.jdoxml.api
Interface IDocumentedElement
-
- All Known Subinterfaces:
IClass
,ICompound
,IDCOP
,IDefine
,IDir
,IEnum
,IEnumValue
,IException
,IFile
,IFriend
,IFunction
,IGroup
,IInterface
,IMember
,INamespace
,IPage
,IProperty
,IPrototype
,ISignal
,ISlot
,IStruct
,ITypedef
,IUnion
,IVariable
- All Known Implementing Classes:
CompoundHandler
,MemberHandler
public interface IDocumentedElement
Interface to summarise elements which have brief and detailed descriptions.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IDocRoot
briefDescription()
provides the brief description for this element.IDocRoot
detailedDescription()
provides the detailed description for this element.
-