RubyCodeDocumentation Class Reference
class RubyCodeDocumentation A Ruby code comment. More...
#include <rubycodedocumentation.h>
Inheritance diagram for RubyCodeDocumentation:
Public Member Functions | |
| RubyCodeDocumentation (RubyClassifierCodeDocument *doc, const QString &text="") | |
| Constructors. | |
| virtual | ~RubyCodeDocumentation () |
| Empty Destructor. | |
| virtual void | saveToXMI (QDomDocument &doc, QDomElement &root) |
| Save the XMI representation of this object. | |
| QString | toString () |
| virtual QString | unformatText (const QString &text, const QString &indent="") |
| UnFormat a long text string. | |
| virtual QString | getNewEditorLine (int amount) |
| a special version here because we want to not only indent the new line, but to add the "# " sequence as well. | |
| virtual int | firstEditableLine () |
| Ush. | |
| virtual int | lastEditableLine () |
Detailed Description
class RubyCodeDocumentation A Ruby code comment.There is only a single styles of comments: these are simply started with a hash and no terminating characters
Definition at line 35 of file rubycodedocumentation.h.
Constructor & Destructor Documentation
|
||||||||||||
|
Constructors.
Definition at line 35 of file rubycodedocumentation.cpp. |
|
|
Empty Destructor.
Definition at line 41 of file rubycodedocumentation.cpp. |
Member Function Documentation
|
||||||||||||
|
Save the XMI representation of this object.
Reimplemented from CodeComment. Definition at line 57 of file rubycodedocumentation.cpp. References TextBlock::setAttributesOnNode(). |
|
|
Reimplemented from TextBlock. Definition at line 67 of file rubycodedocumentation.cpp. References CodeGenerationPolicy::getCommentStyle(), UMLApp::getCommonPolicy(), TextBlock::getIndentationString(), TextBlock::getText(), and TextBlock::getWriteOutText(). |
|
||||||||||||
|
UnFormat a long text string. Typically, this means removing the indentaion (linePrefix) and/or newline chars from each line. Reimplemented from TextBlock. Definition at line 127 of file rubycodedocumentation.cpp. References CodeGenerationPolicy::getCommentStyle(), UMLApp::getCommonPolicy(), and TextBlock::unformatText(). |
|
|
a special version here because we want to not only indent the new line, but to add the "# " sequence as well.
Reimplemented from TextBlock. Definition at line 99 of file rubycodedocumentation.cpp. References CodeGenerationPolicy::getCommentStyle(), UMLApp::getCommonPolicy(), and TextBlock::getIndentationString(). |
|
|
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. Definition at line 108 of file rubycodedocumentation.cpp. References CodeGenerationPolicy::getCommentStyle(), and UMLApp::getCommonPolicy(). |
The documentation for this class was generated from the following files:
