|
1 <?xml version="1.0" encoding="ascii"?> |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
5 <head> |
|
6 <title>comments.CommentParser</title> |
|
7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|
8 <script type="text/javascript" src="epydoc.js"></script> |
|
9 </head> |
|
10 |
|
11 <body bgcolor="white" text="black" link="blue" vlink="#204080" |
|
12 alink="#204080"> |
|
13 <!-- ==================== NAVIGATION BAR ==================== --> |
|
14 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
15 bgcolor="#a0c0ff" cellspacing="0"> |
|
16 <tr valign="middle"> |
|
17 |
|
18 <!-- Tree link --> |
|
19 <th> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </th> |
|
29 |
|
30 <th class="navbar" width="100%"></th> |
|
31 </tr> |
|
32 </table> |
|
33 <table width="100%" cellpadding="0" cellspacing="0"> |
|
34 <tr valign="top"> |
|
35 <td width="100%"> |
|
36 <span class="breadcrumbs"> |
|
37 <a href="comments-module.html">Module comments</a> :: |
|
38 Class CommentParser |
|
39 </span> |
|
40 </td> |
|
41 <td> |
|
42 <table cellpadding="0" cellspacing="0"> |
|
43 <!-- hide/show private --> |
|
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
45 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="comments.CommentParser-class.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Class CommentParser</h1><span class="codelink"><a href="comments-pysrc.html#CommentParser">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <strong class="uidshort">CommentParser</strong> |
|
60 </pre> |
|
61 |
|
62 <hr /> |
|
63 Parse branch information.<br /><br /> |
|
64 |
|
65 <!-- ==================== INSTANCE METHODS ==================== --> |
|
66 <a name="section-InstanceMethods"></a> |
|
67 <table class="summary" border="1" cellpadding="3" |
|
68 cellspacing="0" width="100%" bgcolor="white"> |
|
69 <tr bgcolor="#70b0f0" class="table-header"> |
|
70 <td colspan="2" class="table-header"> |
|
71 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
72 <tr valign="top"> |
|
73 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
74 <td align="right" valign="top" |
|
75 ><span class="options">[<a href="#section-InstanceMethods" |
|
76 class="privatelink" onclick="toggle_private();" |
|
77 >hide private</a>]</span></td> |
|
78 </tr> |
|
79 </table> |
|
80 </td> |
|
81 </tr> |
|
82 <tr> |
|
83 <td width="15%" align="right" valign="top" class="summary"> |
|
84 <span class="summary-type"> </span> |
|
85 </td><td class="summary"> |
|
86 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
87 <tr> |
|
88 <td><span class="summary-sig"><a href="comments.CommentParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
89 <span class="summary-sig-arg">files</span>, |
|
90 <span class="summary-sig-arg">element_name</span>)</span><br /> |
|
91 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> |
|
92 <td align="right" valign="top"> |
|
93 <span class="codelink"><a href="comments-pysrc.html#CommentParser.__init__">source code</a></span> |
|
94 |
|
95 </td> |
|
96 </tr> |
|
97 </table> |
|
98 |
|
99 </td> |
|
100 </tr> |
|
101 <tr> |
|
102 <td width="15%" align="right" valign="top" class="summary"> |
|
103 <span class="summary-type"> </span> |
|
104 </td><td class="summary"> |
|
105 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
106 <tr> |
|
107 <td><span class="summary-sig"><a href="comments.CommentParser-class.html#scan" class="summary-sig-name">scan</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
108 This method goes processes the input files.</td> |
|
109 <td align="right" valign="top"> |
|
110 <span class="codelink"><a href="comments-pysrc.html#CommentParser.scan">source code</a></span> |
|
111 |
|
112 </td> |
|
113 </tr> |
|
114 </table> |
|
115 |
|
116 </td> |
|
117 </tr> |
|
118 <tr> |
|
119 <td colspan="2" class="summary"> |
|
120 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
121 <code>__delattr__</code>, |
|
122 <code>__getattribute__</code>, |
|
123 <code>__hash__</code>, |
|
124 <code>__new__</code>, |
|
125 <code>__reduce__</code>, |
|
126 <code>__reduce_ex__</code>, |
|
127 <code>__repr__</code>, |
|
128 <code>__setattr__</code>, |
|
129 <code>__str__</code> |
|
130 </p> |
|
131 </td> |
|
132 </tr> |
|
133 </table> |
|
134 <!-- ==================== STATIC METHODS ==================== --> |
|
135 <a name="section-StaticMethods"></a> |
|
136 <table class="summary" border="1" cellpadding="3" |
|
137 cellspacing="0" width="100%" bgcolor="white"> |
|
138 <tr bgcolor="#70b0f0" class="table-header"> |
|
139 <td colspan="2" class="table-header"> |
|
140 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
141 <tr valign="top"> |
|
142 <td align="left"><span class="table-header">Static Methods</span></td> |
|
143 <td align="right" valign="top" |
|
144 ><span class="options">[<a href="#section-StaticMethods" |
|
145 class="privatelink" onclick="toggle_private();" |
|
146 >hide private</a>]</span></td> |
|
147 </tr> |
|
148 </table> |
|
149 </td> |
|
150 </tr> |
|
151 <tr> |
|
152 <td width="15%" align="right" valign="top" class="summary"> |
|
153 <span class="summary-type"> </span> |
|
154 </td><td class="summary"> |
|
155 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
156 <tr> |
|
157 <td><span class="summary-sig"><a href="comments.CommentParser-class.html#scan_content" class="summary-sig-name">scan_content</a>(<span class="summary-sig-arg">filename</span>, |
|
158 <span class="summary-sig-arg">content</span>, |
|
159 <span class="summary-sig-arg">element_name</span>, |
|
160 <span class="summary-sig-arg">doc</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
161 This method scan the defined content to find any custom comment tags.</td> |
|
162 <td align="right" valign="top"> |
|
163 <span class="codelink"><a href="comments-pysrc.html#CommentParser.scan_content">source code</a></span> |
|
164 |
|
165 </td> |
|
166 </tr> |
|
167 </table> |
|
168 |
|
169 </td> |
|
170 </tr> |
|
171 </table> |
|
172 <!-- ==================== PROPERTIES ==================== --> |
|
173 <a name="section-Properties"></a> |
|
174 <table class="summary" border="1" cellpadding="3" |
|
175 cellspacing="0" width="100%" bgcolor="white"> |
|
176 <tr bgcolor="#70b0f0" class="table-header"> |
|
177 <td colspan="2" class="table-header"> |
|
178 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
179 <tr valign="top"> |
|
180 <td align="left"><span class="table-header">Properties</span></td> |
|
181 <td align="right" valign="top" |
|
182 ><span class="options">[<a href="#section-Properties" |
|
183 class="privatelink" onclick="toggle_private();" |
|
184 >hide private</a>]</span></td> |
|
185 </tr> |
|
186 </table> |
|
187 </td> |
|
188 </tr> |
|
189 <tr> |
|
190 <td colspan="2" class="summary"> |
|
191 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
192 <code>__class__</code> |
|
193 </p> |
|
194 </td> |
|
195 </tr> |
|
196 </table> |
|
197 <!-- ==================== METHOD DETAILS ==================== --> |
|
198 <a name="section-MethodDetails"></a> |
|
199 <table class="details" border="1" cellpadding="3" |
|
200 cellspacing="0" width="100%" bgcolor="white"> |
|
201 <tr bgcolor="#70b0f0" class="table-header"> |
|
202 <td colspan="2" class="table-header"> |
|
203 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
204 <tr valign="top"> |
|
205 <td align="left"><span class="table-header">Method Details</span></td> |
|
206 <td align="right" valign="top" |
|
207 ><span class="options">[<a href="#section-MethodDetails" |
|
208 class="privatelink" onclick="toggle_private();" |
|
209 >hide private</a>]</span></td> |
|
210 </tr> |
|
211 </table> |
|
212 </td> |
|
213 </tr> |
|
214 </table> |
|
215 <a name="__init__"></a> |
|
216 <div> |
|
217 <table class="details" border="1" cellpadding="3" |
|
218 cellspacing="0" width="100%" bgcolor="white"> |
|
219 <tr><td> |
|
220 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
221 <tr valign="top"><td> |
|
222 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
223 <span class="sig-arg">files</span>, |
|
224 <span class="sig-arg">element_name</span>)</span> |
|
225 <br /><em class="fname">(Constructor)</em> |
|
226 </h3> |
|
227 </td><td align="right" valign="top" |
|
228 ><span class="codelink"><a href="comments-pysrc.html#CommentParser.__init__">source code</a></span> |
|
229 </td> |
|
230 </table> |
|
231 |
|
232 x.__init__(...) initializes x; see x.__class__.__doc__ for signature |
|
233 <dl class="fields"> |
|
234 <dt>Overrides: |
|
235 object.__init__ |
|
236 <dd><em class="note">(inherited documentation)</em></dd> |
|
237 </dt> |
|
238 </dl> |
|
239 </td></tr></table> |
|
240 </div> |
|
241 <a name="scan"></a> |
|
242 <div> |
|
243 <table class="details" border="1" cellpadding="3" |
|
244 cellspacing="0" width="100%" bgcolor="white"> |
|
245 <tr><td> |
|
246 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
247 <tr valign="top"><td> |
|
248 <h3 class="epydoc"><span class="sig"><span class="sig-name">scan</span>(<span class="sig-arg">self</span>)</span> |
|
249 </h3> |
|
250 </td><td align="right" valign="top" |
|
251 ><span class="codelink"><a href="comments-pysrc.html#CommentParser.scan">source code</a></span> |
|
252 </td> |
|
253 </table> |
|
254 |
|
255 <p>This method goes processes the input files.</p> |
|
256 <p>It returns an xml document.</p> |
|
257 <dl class="fields"> |
|
258 </dl> |
|
259 </td></tr></table> |
|
260 </div> |
|
261 <a name="scan_content"></a> |
|
262 <div> |
|
263 <table class="details" border="1" cellpadding="3" |
|
264 cellspacing="0" width="100%" bgcolor="white"> |
|
265 <tr><td> |
|
266 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
267 <tr valign="top"><td> |
|
268 <h3 class="epydoc"><span class="sig"><span class="sig-name">scan_content</span>(<span class="sig-arg">filename</span>, |
|
269 <span class="sig-arg">content</span>, |
|
270 <span class="sig-arg">element_name</span>, |
|
271 <span class="sig-arg">doc</span>=<span class="sig-default">None</span>)</span> |
|
272 <br /><em class="fname">Static Method</em> |
|
273 </h3> |
|
274 </td><td align="right" valign="top" |
|
275 ><span class="codelink"><a href="comments-pysrc.html#CommentParser.scan_content">source code</a></span> |
|
276 </td> |
|
277 </table> |
|
278 |
|
279 <p>This method scan the defined content to find any custom comment tags.</p> |
|
280 <p>It returns an xml document.</p> |
|
281 <dl class="fields"> |
|
282 </dl> |
|
283 </td></tr></table> |
|
284 </div> |
|
285 <br /> |
|
286 <!-- ==================== NAVIGATION BAR ==================== --> |
|
287 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
288 bgcolor="#a0c0ff" cellspacing="0"> |
|
289 <tr valign="middle"> |
|
290 |
|
291 <!-- Tree link --> |
|
292 <th> <a |
|
293 href="module-tree.html">Trees</a> </th> |
|
294 |
|
295 <!-- Index link --> |
|
296 <th> <a |
|
297 href="identifier-index.html">Indices</a> </th> |
|
298 |
|
299 <!-- Help link --> |
|
300 <th> <a |
|
301 href="help.html">Help</a> </th> |
|
302 |
|
303 <th class="navbar" width="100%"></th> |
|
304 </tr> |
|
305 </table> |
|
306 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
307 <tr> |
|
308 <td align="left" class="footer"> |
|
309 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009 |
|
310 </td> |
|
311 <td align="right" class="footer"> |
|
312 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
313 </td> |
|
314 </tr> |
|
315 </table> |
|
316 |
|
317 <script type="text/javascript"> |
|
318 <!-- |
|
319 // Private objects are initially displayed (because if |
|
320 // javascript is turned off then we want them to be |
|
321 // visible); but by default, we want to hide them. So hide |
|
322 // them unless we have a cookie that says to show them. |
|
323 checkCookie() |
|
324 // --> |
|
325 </script> |
|
326 |
|
327 </body> |
|
328 </html> |