io.sarl.lang.documentation
Class DocumentationFormatter
All Superinterfaces:
IDocumentationFormatter
class DocumentationFormatter
extends java.lang.Object
implements IDocumentationFormatter
Formatter a documentation string.
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
Constructor Summary
Constructor and description
new
Action Summary
Property Details
multilineCommentEndSymbols
var multilineCommentEndSymbols : java.lang.String

This property is an alias for the action: getMultilineCommentEndSymbols

multilineCommentLinePrefix
var multilineCommentLinePrefix : java.lang.String

This property is an alias for the action: getMultilineCommentLinePrefix

multilineCommentStartSymbols
var multilineCommentStartSymbols : java.lang.String

This property is an alias for the action: getMultilineCommentStartSymbols

singlelineCommentPrefix
var singlelineCommentPrefix : java.lang.String

This property is an alias for the action: getSinglelineCommentPrefix

singlelineCommentSpecialChars
protected val singlelineCommentSpecialChars : java.util.Set<E>

This property is an alias for the action: getSinglelineCommentSpecialChars

whiteSpacesOnFirstLine
protected val whiteSpacesOnFirstLine : int

This property is an alias for the action: getWhiteSpacesOnFirstLine

whiteSpacesOnOtherLines
protected val whiteSpacesOnOtherLines : int

This property is an alias for the action: getWhiteSpacesOnOtherLines

Constructor Details
new
new
Action Details
formatLineText(String,boolean,FormattedTextAccessor<T>)
protected def formatLineText(String,boolean,FormattedTextAccessor<T>)

with T

formatMultilineComment(String)
def formatMultilineComment(String) : java.lang.String
formatMultilineComment(String,String)
def formatMultilineComment(String,String) : java.lang.String
formatMultilineComment(String,IAppendable)
def formatMultilineComment(String,IAppendable)
formatMultilineComment(ITextReplacerContext,IComment)
def formatMultilineComment(ITextReplacerContext,IComment)
formatMultilineComment(String,String,IAppendable)
def formatMultilineComment(String,String,IAppendable)
formatSinglelineComment(String)
def formatSinglelineComment(String) : java.lang.String
formatSinglelineComment(String,String)
def formatSinglelineComment(String,String) : java.lang.String
formatSinglelineComment(String,IAppendable)
def formatSinglelineComment(String,IAppendable)
formatSinglelineComment(ITextReplacerContext,IComment)
def formatSinglelineComment(ITextReplacerContext,IComment)
formatSinglelineComment(String,String,IAppendable)
def formatSinglelineComment(String,String,IAppendable)
getMultilineCommentEndSymbols
def getMultilineCommentEndSymbols : java.lang.String
getMultilineCommentLinePrefix
def getMultilineCommentLinePrefix : java.lang.String
getMultilineCommentStartSymbols
def getMultilineCommentStartSymbols : java.lang.String
getSinglelineCommentPrefix
def getSinglelineCommentPrefix : java.lang.String
getSinglelineCommentSpecialChars
protected def getSinglelineCommentSpecialChars : java.util.Set<E>
getWhiteSpacesOnFirstLine
protected def getWhiteSpacesOnFirstLine : int
getWhiteSpacesOnOtherLines
protected def getWhiteSpacesOnOtherLines : int
isNewLine(char)
protected def isNewLine(char) : boolean
setGrammarAccess(SARLGrammarAccess)
def setGrammarAccess(SARLGrammarAccess)
setMultilineCommentEndSymbols(String)
def setMultilineCommentEndSymbols(String)
setMultilineCommentLinePrefix(String)
def setMultilineCommentLinePrefix(String)
setMultilineCommentStartSymbols(String)
def setMultilineCommentStartSymbols(String)
setSinglelineCommentPrefix(String)
def setSinglelineCommentPrefix(String)