io.sarl.lang.documentation
Interface IDocumentationFormatter
All Known Implementing Classes:
DocumentationFormatter
interface IDocumentationFormatter
Format a documentation string.
Property Summary
Modifier and type Property and description
java.lang.String multilineCommentEndSymbols
Replies the characters that must be used to end a comment.
java.lang.String multilineCommentLinePrefix
Replies the characters that must be used as prefix of each line in a multiline comment.
java.lang.String multilineCommentStartSymbols
Replies the characters that must be used to start a comment.
java.lang.String singlelineCommentPrefix
Replies the string that must be used as prefix of a singleline comment.
Action Summary
Modifier and type Action and description
abstract java.lang.String formatMultilineComment(String)
Replies the formatted string that corresponds to the given documentation.
abstract java.lang.String formatMultilineComment(String,String)
Replies the formatted string that corresponds to the given documentation.
abstract void formatMultilineComment(String,IAppendable)
Replies the formatted string that corresponds to the given documentation.
abstract void formatMultilineComment(ITextReplacerContext,IComment)
Format the given multiline documentation.
abstract void formatMultilineComment(String,String,IAppendable)
Replies the formatted string that corresponds to the given documentation.
abstract java.lang.String formatSinglelineComment(String)
Replies the formatted string that corresponds to the given documentation.
abstract java.lang.String formatSinglelineComment(String,String)
Replies the formatted string that corresponds to the given documentation.
abstract void formatSinglelineComment(String,IAppendable)
Replies the formatted string that corresponds to the given documentation.
abstract void formatSinglelineComment(ITextReplacerContext,IComment)
Format the given singleline documentation.
abstract void formatSinglelineComment(String,String,IAppendable)
Replies the formatted string that corresponds to the given documentation.
abstract java.lang.String getMultilineCommentEndSymbols
Replies the characters that must be used to end a comment.
abstract java.lang.String getMultilineCommentLinePrefix
Replies the characters that must be used as prefix of each line in a multiline comment.
abstract java.lang.String getMultilineCommentStartSymbols
Replies the characters that must be used to start a comment.
abstract java.lang.String getSinglelineCommentPrefix
Replies the string that must be used as prefix of a singleline comment.
Property Details
multilineCommentEndSymbols 
val multilineCommentEndSymbols : java.lang.String
Replies the characters that must be used to end a comment.

This property is an alias for the action: getMultilineCommentEndSymbols

Returns:
the symbols.
multilineCommentLinePrefix 
val multilineCommentLinePrefix : java.lang.String
Replies the characters that must be used as prefix of each line in a multiline comment.

This property is an alias for the action: getMultilineCommentLinePrefix

Returns:
the prefix.
multilineCommentStartSymbols 
val multilineCommentStartSymbols : java.lang.String
Replies the characters that must be used to start a comment.

This property is an alias for the action: getMultilineCommentStartSymbols

Returns:
the symbols.
singlelineCommentPrefix 
val singlelineCommentPrefix : java.lang.String
Replies the string that must be used as prefix of a singleline comment.

This property is an alias for the action: getSinglelineCommentPrefix

Returns:
the prefix.
Action Details
formatMultilineComment(String) 
def formatMultilineComment(String) : java.lang.String
Replies the formatted string that corresponds to the given documentation.
Parameters:
doc - the documentation text. It may be on multiple lines.
Returns:
the formatted comment.
formatMultilineComment(String,String) 
def formatMultilineComment(String,String) : java.lang.String
Replies the formatted string that corresponds to the given documentation.
Parameters:
doc - the documentation text. It may be on multiple lines.
indentation - the string to put for indenting the comment.
Returns:
the formatted comment.
formatMultilineComment(String,IAppendable) 
def formatMultilineComment(String,IAppendable)
Replies the formatted string that corresponds to the given documentation.
Parameters:
doc - the documentation text. It may be on multiple lines.
appendable - the receiver of the formatted string.
formatMultilineComment(ITextReplacerContext,IComment) 
def formatMultilineComment(ITextReplacerContext,IComment)
Format the given multiline documentation.
Parameters:
context - the formatting context.
comment - the comment to format out.
formatMultilineComment(String,String,IAppendable) 
def formatMultilineComment(String,String,IAppendable)
Replies the formatted string that corresponds to the given documentation.
Parameters:
doc - the documentation text. It may be on multiple lines.
indentation - the string to put for indenting the comment.
appendable - the receiver of the formatted string.
formatSinglelineComment(String) 
def formatSinglelineComment(String) : java.lang.String
Replies the formatted string that corresponds to the given documentation.
Parameters:
doc - the documentation text. It may be on multiple lines.
Returns:
the formatted comment.
formatSinglelineComment(String,String) 
def formatSinglelineComment(String,String) : java.lang.String
Replies the formatted string that corresponds to the given documentation.
Parameters:
doc - the documentation text. It may be on multiple lines.
indentation - the string to put for indenting the comment.
Returns:
the formatted comment.
formatSinglelineComment(String,IAppendable) 
def formatSinglelineComment(String,IAppendable)
Replies the formatted string that corresponds to the given documentation.
Parameters:
doc - the documentation text. It may be on multiple lines.
appendable - the receiver of the formatted string.
formatSinglelineComment(ITextReplacerContext,IComment) 
def formatSinglelineComment(ITextReplacerContext,IComment)
Format the given singleline documentation.
Parameters:
context - the formatting context.
comment - the comment to format out.
formatSinglelineComment(String,String,IAppendable) 
def formatSinglelineComment(String,String,IAppendable)
Replies the formatted string that corresponds to the given documentation.
Parameters:
doc - the documentation text. It may be on multiple lines.
indentation - the string to put for indenting the comment.
appendable - the receiver of the formatted string.
getMultilineCommentEndSymbols 
def getMultilineCommentEndSymbols : java.lang.String
Replies the characters that must be used to end a comment.
Returns:
the symbols.
getMultilineCommentLinePrefix 
def getMultilineCommentLinePrefix : java.lang.String
Replies the characters that must be used as prefix of each line in a multiline comment.
Returns:
the prefix.
getMultilineCommentStartSymbols 
def getMultilineCommentStartSymbols : java.lang.String
Replies the characters that must be used to start a comment.
Returns:
the symbols.
getSinglelineCommentPrefix 
def getSinglelineCommentPrefix : java.lang.String
Replies the string that must be used as prefix of a singleline comment.
Returns:
the prefix.