#include <dcodedocumentation.h>
A class representing a D documentation comment.
The syntax follows the D Style Guide (
- See also
- http://www.digitalmars.com/d/dstyle.html). Choice between single line and multiline comments is based on the common policy.
◆ DCodeDocumentation()
DCodeDocumentation::DCodeDocumentation |
( |
CodeDocument * |
doc, |
|
|
const QString & |
text = QString() |
|
) |
| |
|
explicit |
◆ ~DCodeDocumentation()
DCodeDocumentation::~DCodeDocumentation |
( |
| ) |
|
|
virtual |
◆ firstEditableLine()
int DCodeDocumentation::firstEditableLine |
( |
| ) |
|
|
virtual |
Ush. These are terrifically bad and must one day go away. Both methods indicate the range of lines in this textblock which may be edited by the code editor (assuming that any are actually editable). The default case is no lines are editable. The line numbering starts with '0' and a '-1' means no line qualifies.
Reimplemented from TextBlock.
◆ getNewEditorLine()
QString DCodeDocumentation::getNewEditorLine |
( |
int |
amount | ) |
|
|
virtual |
A special version here because we want to not only indent the new line, but to add the " * " sequence as well.
Reimplemented from TextBlock.
◆ lastEditableLine()
int DCodeDocumentation::lastEditableLine |
( |
| ) |
|
|
virtual |
◆ saveToXMI()
void DCodeDocumentation::saveToXMI |
( |
QXmlStreamWriter & |
writer | ) |
|
|
virtual |
Save the XMI representation of this object.
Reimplemented from CodeComment.
◆ toString()
QString DCodeDocumentation::toString |
( |
| ) |
const |
|
virtual |
Creates a documentation block.
The syntax follows the D Style Guide (
- See also
- http://www.digitalmars.com/d/dstyle.html). Choice between single line and multiline comments is based on the common policy.
- Returns
- QString Documentation block source code.
Reimplemented from TextBlock.
◆ unformatText()
QString DCodeDocumentation::unformatText |
( |
const QString & |
text, |
|
|
const QString & |
indent = QString() |
|
) |
| |
|
virtual |
UnFormat a long text string. Typically, this means removing the indentation (linePrefix) and/or newline chars from each line.
Reimplemented from TextBlock.
The documentation for this class was generated from the following files: