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