#include <javacodedocumentation.h>
class JavaCodeDocumentation A Java code comment. There is only a single styles of comments: these are simply started with double slash sequence and no terminating characters
◆ JavaCodeDocumentation()
◆ ~JavaCodeDocumentation()
JavaCodeDocumentation::~JavaCodeDocumentation |
( |
| ) |
|
|
virtual |
◆ firstEditableLine()
int JavaCodeDocumentation::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 codeeditor (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 JavaCodeDocumentation::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 JavaCodeDocumentation::lastEditableLine |
( |
| ) |
|
|
virtual |
◆ saveToXMI()
void JavaCodeDocumentation::saveToXMI |
( |
QXmlStreamWriter & |
writer | ) |
|
|
virtual |
Save the XMI representation of this object
Reimplemented from CodeComment.
◆ toString()
QString JavaCodeDocumentation::toString |
( |
| ) |
const |
|
virtual |
◆ unformatText()
QString JavaCodeDocumentation::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: