Function
addText
Add text line/paragraph to ToolDoc.
Appends a text paragraph to the ArgumentParser.
addText(doc, text, [isParagraph])
addText(parser, text)
Include Headers
seqan/arg_parse.h, seqan/arg_parse/tool_doc.h
Parameters
doc
Tool documentation object to text to.
Types: ToolDoc
text
Text to add.
The content of the text.
Types: CharString
isParagraph
Whether to insert as paragraph or just a line (only line break in the last case).
Types: bool
parser
The ArgumentParser object.
Remarks
See ToolDoc for information on formatting of text.
Return Values
void
void
See Also
SeqAn - Sequence Analysis Library - www.seqan.de
 

Page built @2012/10/02 11:10:30