Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric5.UtilitiesPython2.Tools.html	Fri Sep 09 09:33:19 2011 +0200
+++ b/Documentation/Source/eric5.UtilitiesPython2.Tools.html	Fri Sep 09 11:54:20 2011 +0200
@@ -38,6 +38,9 @@
 <td><a href="#decode">decode</a></td>
 <td>Function to decode a text.</td>
 </tr><tr>
+<td><a href="#extractLineFlags">extractLineFlags</a></td>
+<td>Function to extract flags starting and ending with '__' from a line comment.</td>
+</tr><tr>
 <td><a href="#get_coding">get_coding</a></td>
 <td>Function to get the coding of a text.</td>
 </tr><tr>
@@ -67,6 +70,30 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="extractLineFlags" ID="extractLineFlags"></a>
+<h2>extractLineFlags</h2>
+<b>extractLineFlags</b>(<i>line, startComment="</i>)
+<p>
+    Function to extract flags starting and ending with '__' from a line comment.
+</p><dl>
+<dt><i>line</i></dt>
+<dd>
+line to extract flags from (string)
+</dd><dt><i>startComment=</i></dt>
+<dd>
+string identifying the start of the comment (string)
+</dd><dt><i>endComment=</i></dt>
+<dd>
+string identifying the end of a comment (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list containing the extracted flags (list of strings)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="get_coding" ID="get_coding"></a>
 <h2>get_coding</h2>
 <b>get_coding</b>(<i>text</i>)