blob: e43cd856490e04f8bd33fe3642e1a0e5a448971e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/***************************************************************************
rubycodedocumentation.h
Derived from the Java code generator by thomas
begin : Thur Jul 21 2005
author : Richard Dale
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* copyright (C) 2006-2007 *
* Umbrello UML Modeller Authors <uml-devel@uml.sf.net> *
***************************************************************************/
#ifndef RUBYCODEDOCUMENTATION_H
#define RUBYCODEDOCUMENTATION_H
#include <tqstring.h>
#include "../codecomment.h"
class RubyClassifierCodeDocument;
/**
* 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
*/
class RubyCodeDocumentation : virtual public CodeComment
{
TQ_OBJECT
public:
// Constructors/Destructors
//
/**
* Constructors
*/
explicit RubyCodeDocumentation ( RubyClassifierCodeDocument * doc, const TQString & text = "");
/**
* Empty Destructor
*/
virtual ~RubyCodeDocumentation ( );
// Public attributes
//
// Other
//
/**
* Save the XMI representation of this object
*/
virtual void saveToXMI ( TQDomDocument & doc, TQDomElement & root );
/**
* @return TQString
*/
TQString toString ( );
/** UnFormat a long text string. Typically, this means removing
* the indentaion (linePrefix) and/or newline chars from each line.
*/
virtual TQString unformatText ( const TQString & text, const TQString & indent = "" );
/** a special version here because we want to not only indent
* the new line, but to add the "# " sequence as well.
*/
virtual TQString getNewEditorLine ( int amount );
/** 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.
*/
virtual int firstEditableLine();
virtual int lastEditableLine();
protected:
private:
};
#endif // RUBYCODEDOCUMENTATION_H
|
