io.sarl.lang.documentation
Class DocumentationFormatter
All Superinterfaces:
IDocumentationFormatter
class DocumentationFormatter
extends java.lang.Object
implements IDocumentationFormatter
Formatter a documentation string.
See:
"DocumentationBuilderFragment.java : appendTo : 654"
Property Summary
Modifier and type Property and description
java.lang.String multilineCommentEndSymbols
java.lang.String multilineCommentLinePrefix
java.lang.String multilineCommentStartSymbols
java.lang.String singlelineCommentPrefix
protected java.util.Set<E> singlelineCommentSpecialChars
protected int whiteSpacesOnFirstLine
protected int whiteSpacesOnOtherLines
Nested Type Summary
Modifier and type Type and description
class DocumentationFormatter.AbstractDebuggingAccessor
class DocumentationFormatter.AbstractReplacementAccessor
interface DocumentationFormatter.FormattedTextAccessor
class DocumentationFormatter.Line
class DocumentationFormatter.RegionAccessor
class DocumentationFormatter.Replacement
class DocumentationFormatter.SubAccessor
Constructor Summary
Constructor and description
new
Action Summary
Modifier and type Action and description
protected void formatLineText(String,boolean,FormattedTextAccessor<T>)
java.lang.String formatMultilineComment(String)
java.lang.String formatMultilineComment(String,String)
void formatMultilineComment(String,IAppendable)
void formatMultilineComment(ITextReplacerContext,IComment)
void formatMultilineComment(String,String,IAppendable)
java.lang.String formatSinglelineComment(String)
java.lang.String formatSinglelineComment(String,String)
void formatSinglelineComment(String,IAppendable)
void formatSinglelineComment(ITextReplacerContext,IComment)
void formatSinglelineComment(String,String,IAppendable)
java.lang.String getMultilineCommentEndSymbols
java.lang.String getMultilineCommentLinePrefix
java.lang.String getMultilineCommentStartSymbols
java.lang.String getSinglelineCommentPrefix
protected java.util.Set<E> getSinglelineCommentSpecialChars
protected int getWhiteSpacesOnFirstLine
protected int getWhiteSpacesOnOtherLines
protected static boolean isNewLine(char)
void setGrammarAccess(SARLGrammarAccess)
void setMultilineCommentEndSymbols(String)
void setMultilineCommentLinePrefix(String)
void setMultilineCommentStartSymbols(String)
void setSinglelineCommentPrefix(String)
Property Details
multilineCommentEndSymbols
var multilineCommentEndSymbols : java.lang.String

This property is an alias for the action: getMultilineCommentEndSymbols

See:
"DocumentationBuilderFragment.java : appendTo : 719"
multilineCommentLinePrefix
var multilineCommentLinePrefix : java.lang.String

This property is an alias for the action: getMultilineCommentLinePrefix

See:
"DocumentationBuilderFragment.java : appendTo : 738"
multilineCommentStartSymbols
var multilineCommentStartSymbols : java.lang.String

This property is an alias for the action: getMultilineCommentStartSymbols

See:
"DocumentationBuilderFragment.java : appendTo : 700"
singlelineCommentPrefix
var singlelineCommentPrefix : java.lang.String

This property is an alias for the action: getSinglelineCommentPrefix

See:
"DocumentationBuilderFragment.java : appendTo : 757"
singlelineCommentSpecialChars
protected val singlelineCommentSpecialChars : java.util.Set<E>

This property is an alias for the action: getSinglelineCommentSpecialChars

See:
"DocumentationBuilderFragment.java : appendTo : 768"
whiteSpacesOnFirstLine
protected val whiteSpacesOnFirstLine : int

This property is an alias for the action: getWhiteSpacesOnFirstLine

See:
"DocumentationBuilderFragment.java : appendTo : 1269"
whiteSpacesOnOtherLines
protected val whiteSpacesOnOtherLines : int

This property is an alias for the action: getWhiteSpacesOnOtherLines

See:
"DocumentationBuilderFragment.java : appendTo : 1277"
Constructor Details
new
new
Action Details
formatLineText(String,boolean,FormattedTextAccessor<T>)
protected def formatLineText(String,boolean,FormattedTextAccessor<T>)
 with T
See:
"DocumentationBuilderFragment.java : appendTo : 1285"
formatMultilineComment(String)
def formatMultilineComment(String) : java.lang.String
See:
"DocumentationBuilderFragment.java : appendTo : 878"
formatMultilineComment(String,String)
def formatMultilineComment(String,String) : java.lang.String
See:
"DocumentationBuilderFragment.java : appendTo : 889"
formatMultilineComment(String,IAppendable)
def formatMultilineComment(String,IAppendable)
See:
"DocumentationBuilderFragment.java : appendTo : 908"
formatMultilineComment(ITextReplacerContext,IComment)
def formatMultilineComment(ITextReplacerContext,IComment)
See:
"DocumentationBuilderFragment.java : appendTo : 946"
formatMultilineComment(String,String,IAppendable)
def formatMultilineComment(String,String,IAppendable)
See:
"DocumentationBuilderFragment.java : appendTo : 921"
formatSinglelineComment(String)
def formatSinglelineComment(String) : java.lang.String
See:
"DocumentationBuilderFragment.java : appendTo : 961"
formatSinglelineComment(String,String)
def formatSinglelineComment(String,String) : java.lang.String
See:
"DocumentationBuilderFragment.java : appendTo : 972"
formatSinglelineComment(String,IAppendable)
def formatSinglelineComment(String,IAppendable)
See:
"DocumentationBuilderFragment.java : appendTo : 991"
formatSinglelineComment(ITextReplacerContext,IComment)
def formatSinglelineComment(ITextReplacerContext,IComment)
See:
"DocumentationBuilderFragment.java : appendTo : 1049"
formatSinglelineComment(String,String,IAppendable)
def formatSinglelineComment(String,String,IAppendable)
See:
"DocumentationBuilderFragment.java : appendTo : 1004"
getMultilineCommentEndSymbols
def getMultilineCommentEndSymbols : java.lang.String
See:
"DocumentationBuilderFragment.java : appendTo : 719"
getMultilineCommentLinePrefix
def getMultilineCommentLinePrefix : java.lang.String
See:
"DocumentationBuilderFragment.java : appendTo : 738"
getMultilineCommentStartSymbols
def getMultilineCommentStartSymbols : java.lang.String
See:
"DocumentationBuilderFragment.java : appendTo : 700"
getSinglelineCommentPrefix
def getSinglelineCommentPrefix : java.lang.String
See:
"DocumentationBuilderFragment.java : appendTo : 757"
getSinglelineCommentSpecialChars
protected def getSinglelineCommentSpecialChars : java.util.Set<E>
See:
"DocumentationBuilderFragment.java : appendTo : 768"
getWhiteSpacesOnFirstLine
protected def getWhiteSpacesOnFirstLine : int
See:
"DocumentationBuilderFragment.java : appendTo : 1269"
getWhiteSpacesOnOtherLines
protected def getWhiteSpacesOnOtherLines : int
See:
"DocumentationBuilderFragment.java : appendTo : 1277"
isNewLine(char)
protected def isNewLine(char) : boolean
See:
"DocumentationBuilderFragment.java : appendTo : 684"
setGrammarAccess(SARLGrammarAccess)
def setGrammarAccess(SARLGrammarAccess)
See:
"DocumentationBuilderFragment.java : appendTo : 803"
setMultilineCommentEndSymbols(String)
def setMultilineCommentEndSymbols(String)
See:
"DocumentationBuilderFragment.java : appendTo : 730"
setMultilineCommentLinePrefix(String)
def setMultilineCommentLinePrefix(String)
See:
"DocumentationBuilderFragment.java : appendTo : 749"
setMultilineCommentStartSymbols(String)
def setMultilineCommentStartSymbols(String)
See:
"DocumentationBuilderFragment.java : appendTo : 711"
setSinglelineCommentPrefix(String)
def setSinglelineCommentPrefix(String)
See:
"DocumentationBuilderFragment.java : appendTo : 795"