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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>Class: RawTextConverter</title>
</head>
<body bgcolor="#ffffff">
<p><i><a href="../../../../index.html">Table of Contents</a></i></p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th rowspan="2"
valign="top"
align="left"
width="10%"
bgcolor="#88bbee"><font color="#000000">Class: RawTextConverter</font>
</th>
<th bgcolor="#88bbee"
width="90%"
align="right"><font color="#000000">../HappyDoc-r2_1/happydoclib/docstring/docstring_RawText.py</font>
</th>
</tr>
<tr>
<td>
<h3>Raw (pass-through) docstring converter.</h3>
<p> This is most useful for internal calls in a formatter. For
instance, if a formatter calls self.writeText() and passes text
that it has produced, it can use "RawText" as the <code>textFormat</code>
argument.</p>
<p> This converter is not recommended for most uses.</p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Base Classes">Base Classes</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
happydoclib.happydocstring.HappyDocStringConverterBase<br>
</td></tr>
</table>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Methods">Methods</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<a href="#convert">convert</a><br>
<a href="#quote">quote</a><br>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="convert"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">convert </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
convert (
self,
inputText,
outputFormat,
*args,
*namedArgs,
)
</pre></font>
<h3>Returns the <code>inputText</code> data translated into the <code>outputFormat</code>.</h3>
<h4> Parameters:</h4>
<dl>
<dt> <code>inputText</code></dt>
<dd>String or other sequence of characters to be
converted. This string should be in the format advertised
by the docstring converter.</dd>
<dt> <code>outputFormat</code></dt>
<dd>String defined by the docstring converter
class to represent a supported output scheme. This value is
converter-specific, and not all converters will support the
same output formats.</dd>
</dl>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="quote"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">quote </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
quote (
self,
inputText,
outputFormat,
*args,
*namedArgs,
)
</pre></font>
<h3>Returns the <code>inputText</code> quoted in a way that special characters are escaped.</h3>
<h4> Parameters:</h4>
<dl>
<dt> <code>inputText</code></dt>
<dd>String or other sequence of characters to be
converted. This string should be in the format advertised
by the docstring converter.</dd>
<dt> <code>outputFormat</code></dt>
<dd>String defined by the docstring converter
class to represent a supported output scheme. This value is
converter-specific, and not all converters will support the
same output formats.</dd>
<dt> <code>*args</code></dt>
<dd>Additional, converter-specific, positional arguments.</dd>
<dt> <code>**namedArgs</code></dt>
<dd>Additional, converter-specific, named arguments.</dd>
</dl>
</td></tr>
</td></tr>
</table>
</td>
</tr>
</table>
<hr>
<p><i><a href="../../../../index.html">Table of Contents</a></i></p>
<font size="-2"><i>This document was automatically generated
on Sat Aug 24 16:57:29 2002 by
<a href="http://happydoc.sourceforge.net">HappyDoc</a> version
2.1</i></font>
</body>
</html>
|
