io.sarl.lang.documentation
Interface IEcoreDocumentationBuilder
All Known Implementing Classes:
EcoreDocumentationBuilder
interface IEcoreDocumentationBuilder
Build a documentation string for specific objects.
Property Summary
Modifier and type Property and description
IDocumentationFormatter documentationFormatter
Replies the documentation formatter used by this builder.
org.eclipse.xtext.AbstractRule mLCommentRule
Replies the grammar rule that corresponds to multiline comments.
org.eclipse.xtext.AbstractRule sLCommentRule
Replies the grammar rule that corresponds to singleline comments.
Action Summary
Modifier and type Action and description
abstract java.lang.String build(String,Class<T>)
Replies the formatted string that corresponds to the given documentation.
abstract IDocumentationFormatter getDocumentationFormatter
Replies the documentation formatter used by this builder.
abstract org.eclipse.xtext.AbstractRule getMLCommentRule
Replies the grammar rule that corresponds to multiline comments.
abstract org.eclipse.xtext.AbstractRule getSLCommentRule
Replies the grammar rule that corresponds to singleline comments.
abstract boolean isMultilineCommentFor(Class<T>)
Replies if multiline comments are the default for the given type of objects.
Property Details
documentationFormatter 
val documentationFormatter : IDocumentationFormatter
Replies the documentation formatter used by this builder.

This property is an alias for the action: getDocumentationFormatter

Returns:
documentation formatter.
mLCommentRule 
val mLCommentRule : org.eclipse.xtext.AbstractRule
Replies the grammar rule that corresponds to multiline comments.

This property is an alias for the action: getMLCommentRule

Returns:
the ML grammar rule.
sLCommentRule 
val sLCommentRule : org.eclipse.xtext.AbstractRule
Replies the grammar rule that corresponds to singleline comments.

This property is an alias for the action: getSLCommentRule

Returns:
the SL grammar rule.
Action Details
build(String,Class<T>) 
def build(String,Class<T>) : java.lang.String
Replies the formatted string that corresponds to the given documentation.
Parameters:
doc - the documentation text. It may be on multiple lines.
objectType - the type of the object for which the document must be built.
Returns:
the formatted comment.
getDocumentationFormatter 
def getDocumentationFormatter : IDocumentationFormatter
Replies the documentation formatter used by this builder.
Returns:
documentation formatter.
getMLCommentRule 
def getMLCommentRule : org.eclipse.xtext.AbstractRule
Replies the grammar rule that corresponds to multiline comments.
Returns:
the ML grammar rule.
getSLCommentRule 
def getSLCommentRule : org.eclipse.xtext.AbstractRule
Replies the grammar rule that corresponds to singleline comments.
Returns:
the SL grammar rule.
isMultilineCommentFor(Class<T>) 
def isMultilineCommentFor(Class<T>) : boolean
Replies if multiline comments are the default for the given type of objects.
Parameters:
type - the type of objects.
Returns:
true if multiline comment is the default. Otherwise singleline comment is the default.