<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.docstringparser</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
Module docstringparser
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.docstringparser-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.docstringparser-module.html">Module epydoc.docstringparser</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># epydoc -- Docstring processing</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Copyright (C) 2005 Edward Loper</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Author: Edward Loper <edloper@loper.org></tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># URL: <http://epydoc.sf.net></tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># $Id: docstringparser.py 1689 2008-01-30 17:01:02Z edloper $</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-docstring">Parse docstrings and handle any fields it defines, such as C{@type}</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">and C{@author}. Fields are used to describe specific information</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring">about an object. There are two classes of fields: X{simple fields}</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">and X{special fields}.</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">Simple fields are fields that get stored directly in an C{APIDoc}'s</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring">metadata dictionary, without any special processing. The set of</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">simple fields is defined by the list L{STANDARD_FIELDS}, whose</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring">elements are L{DocstringField}s.</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">Special fields are fields that perform some sort of processing on the</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring">C{APIDoc}, or add information to attributes other than the metadata</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring">dictionary. Special fields are are handled by field handler</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring">functions, which are registered using L{register_field_handler}.</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext en'</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Imports</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt><tt class="py-op">,</tt> <tt class="py-name">sys</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-0', 'epydoc', 'link-0');">epydoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Package epydoc.markup=epydoc.markup-module.html,Method epydoc.markup.doctest.DoctestColorizer.markup()=epydoc.markup.doctest.DoctestColorizer-class.html#markup,Method epydoc.markup.doctest.HTMLDoctestColorizer.markup()=epydoc.markup.doctest.HTMLDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.LaTeXDoctestColorizer.markup()=epydoc.markup.doctest.LaTeXDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.XMLDoctestColorizer.markup()=epydoc.markup.doctest.XMLDoctestColorizer-class.html#markup"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-1', 'markup', 'link-1');">markup</a></tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-2', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-3', 'markup', 'link-1');">markup</a></tt> <tt class="py-keyword">import</tt> <tt id="link-4" class="py-name" targets="Module epydoc.markup.epytext=epydoc.markup.epytext-module.html"><a title="epydoc.markup.epytext" class="py-name" href="#" onclick="return doclink('link-4', 'epytext', 'link-4');">epytext</a></tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-5" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-5', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Module epydoc.apidoc=epydoc.apidoc-module.html"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-6', 'apidoc', 'link-6');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-7" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-7', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Module epydoc.docintrospecter=epydoc.docintrospecter-module.html"><a title="epydoc.docintrospecter" class="py-name" href="#" onclick="return doclink('link-8', 'docintrospecter', 'link-8');">docintrospecter</a></tt> <tt class="py-keyword">import</tt> <tt id="link-9" class="py-name" targets="Function epydoc.docintrospecter.introspect_docstring_lineno()=epydoc.docintrospecter-module.html#introspect_docstring_lineno"><a title="epydoc.docintrospecter.introspect_docstring_lineno" class="py-name" href="#" onclick="return doclink('link-9', 'introspect_docstring_lineno', 'link-9');">introspect_docstring_lineno</a></tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-10" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-10', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Module epydoc.test.util=epydoc.test.util-module.html,Module epydoc.util=epydoc.util-module.html"><a title="epydoc.test.util
epydoc.util" class="py-name" href="#" onclick="return doclink('link-11', 'util', 'link-11');">util</a></tt> <tt class="py-keyword">import</tt> <tt id="link-12" class="py-name" targets="Function epydoc.util.py_src_filename()=epydoc.util-module.html#py_src_filename"><a title="epydoc.util.py_src_filename" class="py-name" href="#" onclick="return doclink('link-12', 'py_src_filename', 'link-12');">py_src_filename</a></tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-13" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-13', 'epydoc', 'link-0');">epydoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-14" class="py-name" targets="Method epydoc.cli.ConsoleLogger.log()=epydoc.cli.ConsoleLogger-class.html#log,Method epydoc.cli.HTMLLogger.log()=epydoc.cli.HTMLLogger-class.html#log,Method epydoc.gui.GUILogger.log()=epydoc.gui.GUILogger-class.html#log,Module epydoc.log=epydoc.log-module.html,Method epydoc.log.Logger.log()=epydoc.log.Logger-class.html#log,Method epydoc.log.SimpleLogger.log()=epydoc.log.SimpleLogger-class.html#log"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-14', 'log', 'link-14');">log</a></tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-15" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-15', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Module epydoc.docparser=epydoc.docparser-module.html"><a title="epydoc.docparser" class="py-name" href="#" onclick="return doclink('link-16', 'docparser', 'link-16');">docparser</a></tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">__builtin__</tt><tt class="py-op">,</tt> <tt class="py-name">exceptions</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Docstring Fields</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="DocstringField"></a><div id="DocstringField-def"><a name="L46"></a><tt class="py-lineno"> 46</tt> <a class="py-toggle" href="#" id="DocstringField-toggle" onclick="return toggle('DocstringField');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docstringparser.DocstringField-class.html">DocstringField</a><tt class="py-op">:</tt> </tt>
</div><div id="DocstringField-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="DocstringField-expanded"><a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> A simple docstring field, which can be used to describe specific</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"> information about an object, such as its author or its version.</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"> Simple docstring fields are fields that take no arguments, and</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> are displayed as simple sections.</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> @ivar tags: The set of tags that can be used to identify this</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"> field.</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> @ivar singular: The label that should be used to identify this</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"> field in the output, if the field contains one value.</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> @ivar plural: The label that should be used to identify this</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> field in the output, if the field contains multiple values.</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> @ivar short: If true, then multiple values should be combined</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> into a single comma-delimited list. If false, then</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> multiple values should be listed separately in a bulleted</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> list.</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"> @ivar multivalue: If true, then multiple values may be given</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> for this field; if false, then this field can only take a</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> single value, and a warning should be issued if it is</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> redefined.</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> @ivar takes_arg: If true, then this field expects an argument;</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"> and a separate field section will be constructed for each</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> argument value. The label (and plural label) should include</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"> a '%s' to mark where the argument's string rep should be</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> added.</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="DocstringField.__init__"></a><div id="DocstringField.__init__-def"><a name="L73"></a><tt class="py-lineno"> 73</tt> <a class="py-toggle" href="#" id="DocstringField.__init__-toggle" onclick="return toggle('DocstringField.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser.DocstringField-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">tags</tt><tt class="py-op">,</tt> <tt class="py-param">label</tt><tt class="py-op">,</tt> <tt class="py-param">plural</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-param">short</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">multivalue</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">takes_arg</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-param">varnames</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocstringField.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocstringField.__init__-expanded"><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">tags</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">list</tt><tt class="py-op">,</tt> <tt class="py-name">tuple</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tags</tt> <tt class="py-op">=</tt> <tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">tags</tt><tt class="py-op">)</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">tags</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">str</tt><tt class="py-op">:</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tags</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">tags</tt><tt class="py-op">,</tt><tt class="py-op">)</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad tags: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">tags</tt><tt class="py-op">)</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">singular</tt> <tt class="py-op">=</tt> <tt id="link-17" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.label()=epydoc.docwriter.latex.LatexWriter-class.html#label"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-17', 'label', 'link-17');">label</a></tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">plural</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">plural</tt> <tt class="py-op">=</tt> <tt id="link-18" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-18', 'label', 'link-17');">label</a></tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">plural</tt> <tt class="py-op">=</tt> <tt class="py-name">plural</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">multivalue</tt> <tt class="py-op">=</tt> <tt class="py-name">multivalue</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">short</tt> <tt class="py-op">=</tt> <tt class="py-name">short</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">takes_arg</tt> <tt class="py-op">=</tt> <tt class="py-name">takes_arg</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">varnames</tt> <tt class="py-op">=</tt> <tt class="py-name">varnames</tt> <tt class="py-keyword">or</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> </tt>
<a name="DocstringField.__cmp__"></a><div id="DocstringField.__cmp__-def"><a name="L89"></a><tt class="py-lineno"> 89</tt> <a class="py-toggle" href="#" id="DocstringField.__cmp__-toggle" onclick="return toggle('DocstringField.__cmp__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser.DocstringField-class.html#__cmp__">__cmp__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocstringField.__cmp__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocstringField.__cmp__-expanded"><a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">,</tt> <tt id="link-19" class="py-name" targets="Class epydoc.docstringparser.DocstringField=epydoc.docstringparser.DocstringField-class.html"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-19', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">cmp</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tags</tt><tt class="py-op">,</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">tags</tt><tt class="py-op">)</tt> </tt>
</div><a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> </tt>
<a name="DocstringField.__hash__"></a><div id="DocstringField.__hash__-def"><a name="L93"></a><tt class="py-lineno"> 93</tt> <a class="py-toggle" href="#" id="DocstringField.__hash__-toggle" onclick="return toggle('DocstringField.__hash__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser.DocstringField-class.html#__hash__">__hash__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocstringField.__hash__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocstringField.__hash__-expanded"><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">hash</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tags</tt><tt class="py-op">)</tt> </tt>
</div><a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> </tt>
<a name="DocstringField.__repr__"></a><div id="DocstringField.__repr__-def"><a name="L96"></a><tt class="py-lineno"> 96</tt> <a class="py-toggle" href="#" id="DocstringField.__repr__-toggle" onclick="return toggle('DocstringField.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser.DocstringField-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocstringField.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocstringField.__repr__-expanded"><a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<Field: %s>'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">tags</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
</div></div><a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt id="link-20" class="py-name" targets="Variable epydoc.docstringparser.STANDARD_FIELDS=epydoc.docstringparser-module.html#STANDARD_FIELDS"><a title="epydoc.docstringparser.STANDARD_FIELDS" class="py-name" href="#" onclick="return doclink('link-20', 'STANDARD_FIELDS', 'link-20');">STANDARD_FIELDS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"> <tt class="py-comment">#: A list of the standard simple fields accepted by epydoc. This</tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"> <tt class="py-comment">#: list can be augmented at run-time by a docstring with the special</tt> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"> <tt class="py-comment">#: C{@deffield} field. The order in which fields are listed here</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"> <tt class="py-comment">#: determines the order in which they will be displayed in the</tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"> <tt class="py-comment">#: output.</tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> <tt class="py-comment"># If it's deprecated, put that first.</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"> <tt id="link-21" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-21', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'deprecated'</tt><tt class="py-op">,</tt> <tt class="py-string">'depreciated'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"> <tt class="py-string">'Deprecated'</tt><tt class="py-op">,</tt> <tt class="py-name">multivalue</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">varnames</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-string">'__deprecated__'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"> <tt class="py-comment"># Status info</tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"> <tt id="link-22" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-22', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'version'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Version'</tt><tt class="py-op">,</tt> <tt class="py-name">multivalue</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"> <tt class="py-name">varnames</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-string">'__version__'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"> <tt id="link-23" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-23', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'date'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Date'</tt><tt class="py-op">,</tt> <tt class="py-name">multivalue</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"> <tt class="py-name">varnames</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-string">'__date__'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"> <tt id="link-24" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-24', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'status'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Status'</tt><tt class="py-op">,</tt> <tt class="py-name">multivalue</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"> </tt>
<a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"> <tt class="py-comment"># Bibliographic Info</tt> </tt>
<a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"> <tt id="link-25" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-25', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'author'</tt><tt class="py-op">,</tt> <tt class="py-string">'authors'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Author'</tt><tt class="py-op">,</tt> <tt class="py-string">'Authors'</tt><tt class="py-op">,</tt> <tt class="py-name">short</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"> <tt class="py-name">varnames</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-string">'__author__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__authors__'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"> <tt id="link-26" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-26', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'contact'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Contact'</tt><tt class="py-op">,</tt> <tt class="py-string">'Contacts'</tt><tt class="py-op">,</tt> <tt class="py-name">short</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"> <tt class="py-name">varnames</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-string">'__contact__'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"> <tt id="link-27" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-27', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'organization'</tt><tt class="py-op">,</tt> <tt class="py-string">'org'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"> <tt class="py-string">'Organization'</tt><tt class="py-op">,</tt> <tt class="py-string">'Organizations'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> <tt id="link-28" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-28', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'copyright'</tt><tt class="py-op">,</tt> <tt class="py-string">'(c)'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Copyright'</tt><tt class="py-op">,</tt> <tt class="py-name">multivalue</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"> <tt class="py-name">varnames</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-string">'__copyright__'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"> <tt id="link-29" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-29', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'license'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'License'</tt><tt class="py-op">,</tt> <tt class="py-name">multivalue</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"> <tt class="py-name">varnames</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-string">'__license__'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"> <tt class="py-comment"># Various warnings etc.</tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"> <tt id="link-30" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-30', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'bug'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Bug'</tt><tt class="py-op">,</tt> <tt class="py-string">'Bugs'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"> <tt id="link-31" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-31', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'warning'</tt><tt class="py-op">,</tt> <tt class="py-string">'warn'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Warning'</tt><tt class="py-op">,</tt> <tt class="py-string">'Warnings'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"> <tt id="link-32" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-32', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'attention'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Attention'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"> <tt id="link-33" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-33', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'note'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Note'</tt><tt class="py-op">,</tt> <tt class="py-string">'Notes'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"> <tt class="py-comment"># Formal conditions</tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"> <tt id="link-34" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-34', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'requires'</tt><tt class="py-op">,</tt> <tt class="py-string">'require'</tt><tt class="py-op">,</tt> <tt class="py-string">'requirement'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Requires'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"> <tt id="link-35" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-35', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'precondition'</tt><tt class="py-op">,</tt> <tt class="py-string">'precond'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"> <tt class="py-string">'Precondition'</tt><tt class="py-op">,</tt> <tt class="py-string">'Preconditions'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"> <tt id="link-36" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-36', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'postcondition'</tt><tt class="py-op">,</tt> <tt class="py-string">'postcond'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"> <tt class="py-string">'Postcondition'</tt><tt class="py-op">,</tt> <tt class="py-string">'Postconditions'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"> <tt id="link-37" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-37', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'invariant'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Invariant'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"> <tt class="py-comment"># When was it introduced (version # or date)</tt> </tt>
<a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"> <tt id="link-38" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-38', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'since'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Since'</tt><tt class="py-op">,</tt> <tt class="py-name">multivalue</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"> </tt>
<a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"> <tt class="py-comment"># Changes made</tt> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"> <tt id="link-39" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-39', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'change'</tt><tt class="py-op">,</tt> <tt class="py-string">'changed'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Change Log'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"> <tt class="py-comment"># Crossreferences</tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"> <tt id="link-40" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-40', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'see'</tt><tt class="py-op">,</tt> <tt class="py-string">'seealso'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'See Also'</tt><tt class="py-op">,</tt> <tt class="py-name">short</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"> <tt class="py-comment"># Future Work</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"> <tt id="link-41" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-41', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'todo'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'To Do'</tt><tt class="py-op">,</tt> <tt class="py-name">takes_arg</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"> </tt>
<a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"> <tt class="py-comment"># Permissions (used by zope-based projects)</tt> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"> <tt id="link-42" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-42', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'permission'</tt><tt class="py-op">,</tt> <tt class="py-string">'permissions'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'Permission'</tt><tt class="py-op">,</tt> <tt class="py-string">'Permissions'</tt><tt class="py-op">)</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Docstring Parsing</tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"><tt id="link-43" class="py-name" targets="Variable epydoc.cli.DEFAULT_DOCFORMAT=epydoc.cli-module.html#DEFAULT_DOCFORMAT,Variable epydoc.docstringparser.DEFAULT_DOCFORMAT=epydoc.docstringparser-module.html#DEFAULT_DOCFORMAT"><a title="epydoc.cli.DEFAULT_DOCFORMAT
epydoc.docstringparser.DEFAULT_DOCFORMAT" class="py-name" href="#" onclick="return doclink('link-43', 'DEFAULT_DOCFORMAT', 'link-43');">DEFAULT_DOCFORMAT</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext'</tt> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"><tt class="py-string">"""The name of the default markup languge used to process docstrings."""</tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"><tt class="py-comment"># [xx] keep track of which ones we've already done, in case we're</tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># asked to process one twice? e.g., for @include we might have to</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># parse the included docstring earlier than we might otherwise..??</tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="parse_docstring"></a><div id="parse_docstring-def"><a name="L170"></a><tt class="py-lineno"> 170</tt> <a class="py-toggle" href="#" id="parse_docstring-toggle" onclick="return toggle('parse_docstring');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#parse_docstring">parse_docstring</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">suppress_warnings</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_docstring-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_docstring-expanded"><a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"><tt class="py-docstring"> Process the given C{APIDoc}'s docstring. In particular, populate</tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"><tt class="py-docstring"> the C{APIDoc}'s C{descr} and C{summary} attributes, and add any</tt> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"><tt class="py-docstring"> information provided by fields in the docstring.</tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"><tt class="py-docstring"> @param docindex: A DocIndex, used to find the containing</tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"><tt class="py-docstring"> module (to look up the docformat); and to find any</tt> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"><tt class="py-docstring"> user docfields defined by containing objects.</tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"><tt class="py-docstring"> @param suppress_warnings: A set of objects for which docstring</tt> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"><tt class="py-docstring"> warnings should be suppressed.</tt> </tt>
<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name" targets="Variable epydoc.apidoc.APIDoc.metadata=epydoc.apidoc.APIDoc-class.html#metadata"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-44', 'metadata', 'link-44');">metadata</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-45" class="py-name" targets="Variable epydoc.apidoc.UNKNOWN=epydoc.apidoc-module.html#UNKNOWN"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-45', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-46" class="py-name" targets="Class epydoc.apidoc.RoutineDoc=epydoc.apidoc.RoutineDoc-class.html"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-46', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name" targets="Variable epydoc.apidoc.GenericValueDoc.canonical_name=epydoc.apidoc.GenericValueDoc-class.html#canonical_name,Variable epydoc.apidoc.ValueDoc.canonical_name=epydoc.apidoc.ValueDoc-class.html#canonical_name,Variable epydoc.apidoc.VariableDoc.canonical_name=epydoc.apidoc.VariableDoc-class.html#canonical_name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-47', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'__init__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"> <tt id="link-48" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-48', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-49" class="py-name" targets="Function epydoc.log.debug()=epydoc.log-module.html#debug,Method epydoc.markup.restructuredtext.OptimizedReporter.debug()=epydoc.markup.restructuredtext.OptimizedReporter-class.html#debug"><a title="epydoc.log.debug
epydoc.markup.restructuredtext.OptimizedReporter.debug" class="py-name" href="#" onclick="return doclink('link-49', 'debug', 'link-49');">debug</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s's docstring processed twice"</tt> <tt class="py-op">%</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-50', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"> <tt id="link-51" class="py-name" targets="Function epydoc.docstringparser.initialize_api_doc()=epydoc.docstringparser-module.html#initialize_api_doc"><a title="epydoc.docstringparser.initialize_api_doc" class="py-name" href="#" onclick="return doclink('link-51', 'initialize_api_doc', 'link-51');">initialize_api_doc</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"> <tt class="py-comment"># If there's no docstring, then check for special variables (e.g.,</tt> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># __version__), and then return -- there's nothing else to do.</tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docstring=epydoc.apidoc.APIDoc-class.html#docstring"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-52', 'docstring', 'link-52');">docstring</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-53" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-53', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-54" class="py-name" targets="Class epydoc.apidoc.NamespaceDoc=epydoc.apidoc.NamespaceDoc-class.html"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-54', 'NamespaceDoc', 'link-54');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt id="link-55" class="py-name"><a title="epydoc.docstringparser.STANDARD_FIELDS" class="py-name" href="#" onclick="return doclink('link-55', 'STANDARD_FIELDS', 'link-20');">STANDARD_FIELDS</a></tt> <tt class="py-op">+</tt> <tt id="link-56" class="py-name" targets="Function epydoc.docstringparser.user_docfields()=epydoc.docstringparser-module.html#user_docfields"><a title="epydoc.docstringparser.user_docfields" class="py-name" href="#" onclick="return doclink('link-56', 'user_docfields', 'link-56');">user_docfields</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"> <tt id="link-57" class="py-name" targets="Function epydoc.docstringparser.add_metadata_from_var()=epydoc.docstringparser-module.html#add_metadata_from_var"><a title="epydoc.docstringparser.add_metadata_from_var" class="py-name" href="#" onclick="return doclink('link-57', 'add_metadata_from_var', 'link-57');">add_metadata_from_var</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">)</tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"> <tt class="py-comment"># Remove leading indentation from the docstring.</tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-58" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-58', 'docstring', 'link-52');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-59" class="py-name" targets="Function epydoc.docstringparser.unindent_docstring()=epydoc.docstringparser-module.html#unindent_docstring"><a title="epydoc.docstringparser.unindent_docstring" class="py-name" href="#" onclick="return doclink('link-59', 'unindent_docstring', 'link-59');">unindent_docstring</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-60', 'docstring', 'link-52');">docstring</a></tt><tt class="py-op">)</tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"> <tt class="py-comment"># Decide which docformat is used by this module.</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-61" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.docformat=epydoc.apidoc.ModuleDoc-class.html#docformat"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-61', 'docformat', 'link-61');">docformat</a></tt> <tt class="py-op">=</tt> <tt id="link-62" class="py-name" targets="Function epydoc.docstringparser.get_docformat()=epydoc.docstringparser-module.html#get_docformat"><a title="epydoc.docstringparser.get_docformat" class="py-name" href="#" onclick="return doclink('link-62', 'get_docformat', 'link-62');">get_docformat</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">)</tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"> <tt class="py-comment"># A list of markup errors from parsing.</tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parse_errors</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> <tt class="py-comment"># Extract a signature from the docstring, if it has one. This</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># overrides any signature we got via introspection/parsing.</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-63" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-63', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"> <tt id="link-64" class="py-name" targets="Function epydoc.docstringparser.parse_function_signature()=epydoc.docstringparser-module.html#parse_function_signature"><a title="epydoc.docstringparser.parse_function_signature" class="py-name" href="#" onclick="return doclink('link-64', 'parse_function_signature', 'link-64');">parse_function_signature</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-65" class="py-name"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-65', 'docformat', 'link-61');">docformat</a></tt><tt class="py-op">,</tt> <tt class="py-name">parse_errors</tt><tt class="py-op">)</tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"> <tt class="py-comment"># Parse the docstring. Any errors encountered are stored as</tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># `ParseError` objects in the errors list.</tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parsed_docstring</tt> <tt class="py-op">=</tt> <tt id="link-66" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-66', 'markup', 'link-1');">markup</a></tt><tt class="py-op">.</tt><tt id="link-67" class="py-name" targets="Function epydoc.markup.epytext.parse()=epydoc.markup.epytext-module.html#parse,Function epydoc.markup.parse()=epydoc.markup-module.html#parse"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-67', 'parse', 'link-67');">parse</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-68', 'docstring', 'link-52');">docstring</a></tt><tt class="py-op">,</tt> <tt id="link-69" class="py-name"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-69', 'docformat', 'link-61');">docformat</a></tt><tt class="py-op">,</tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"> <tt class="py-name">parse_errors</tt><tt class="py-op">)</tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"> <tt class="py-comment"># Divide the docstring into a description and a list of</tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># fields.</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-70" class="py-name" targets="Variable epydoc.apidoc.APIDoc.descr=epydoc.apidoc.APIDoc-class.html#descr,Variable epydoc.cli.descr=epydoc.cli-module.html#descr,Method epydoc.docwriter.html.HTMLWriter.descr()=epydoc.docwriter.html.HTMLWriter-class.html#descr,Method epydoc.markup.ParseError.descr()=epydoc.markup.ParseError-class.html#descr,Method epydoc.markup.epytext.ColorizingError.descr()=epydoc.markup.epytext.ColorizingError-class.html#descr"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-70', 'descr', 'link-70');">descr</a></tt><tt class="py-op">,</tt> <tt class="py-name">fields</tt> <tt class="py-op">=</tt> <tt class="py-name">parsed_docstring</tt><tt class="py-op">.</tt><tt id="link-71" class="py-name" targets="Method epydoc.markup.ConcatenatedDocstring.split_fields()=epydoc.markup.ConcatenatedDocstring-class.html#split_fields,Method epydoc.markup.ParsedDocstring.split_fields()=epydoc.markup.ParsedDocstring-class.html#split_fields,Method epydoc.markup.epytext.ParsedEpytextDocstring.split_fields()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#split_fields,Method epydoc.markup.javadoc.ParsedJavadocDocstring.split_fields()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#split_fields,Method epydoc.markup.restructuredtext.ParsedRstDocstring.split_fields()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#split_fields"><a title="epydoc.markup.ConcatenatedDocstring.split_fields
epydoc.markup.ParsedDocstring.split_fields
epydoc.markup.epytext.ParsedEpytextDocstring.split_fields
epydoc.markup.javadoc.ParsedJavadocDocstring.split_fields
epydoc.markup.restructuredtext.ParsedRstDocstring.split_fields" class="py-name" href="#" onclick="return doclink('link-71', 'split_fields', 'link-71');">split_fields</a></tt><tt class="py-op">(</tt><tt class="py-name">parse_errors</tt><tt class="py-op">)</tt> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-72', 'descr', 'link-70');">descr</a></tt> <tt class="py-op">=</tt> <tt id="link-73" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-73', 'descr', 'link-70');">descr</a></tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> <tt class="py-name">field_warnings</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"> <tt class="py-comment"># Handle the constructor fields that have been defined in the class</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># docstring. This code assumes that a class docstring is parsed before</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the same class __init__ docstring.</tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-74" class="py-name" targets="Class epydoc.apidoc.ClassDoc=epydoc.apidoc.ClassDoc-class.html"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-74', 'ClassDoc', 'link-74');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"> <tt class="py-comment"># Parse ahead the __init__ docstring for this class</tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">initvar</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.variables=epydoc.apidoc.NamespaceDoc-class.html#variables"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-75', 'variables', 'link-75');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'__init__'</tt><tt class="py-op">)</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">initvar</tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">initvar</tt><tt class="py-op">.</tt><tt id="link-76" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.value=epydoc.apidoc.VariableDoc-class.html#value"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-76', 'value', 'link-76');">value</a></tt><tt class="py-op">,</tt> <tt id="link-77" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-77', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"> <tt class="py-name">init_api_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">initvar</tt><tt class="py-op">.</tt><tt id="link-78" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-78', 'value', 'link-76');">value</a></tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"> <tt id="link-79" class="py-name" targets="Function epydoc.docstringparser.parse_docstring()=epydoc.docstringparser-module.html#parse_docstring,Function epydoc.markup.epytext.parse_docstring()=epydoc.markup.epytext-module.html#parse_docstring,Function epydoc.markup.javadoc.parse_docstring()=epydoc.markup.javadoc-module.html#parse_docstring,Function epydoc.markup.plaintext.parse_docstring()=epydoc.markup.plaintext-module.html#parse_docstring,Function epydoc.markup.restructuredtext.parse_docstring()=epydoc.markup.restructuredtext-module.html#parse_docstring"><a title="epydoc.docstringparser.parse_docstring
epydoc.markup.epytext.parse_docstring
epydoc.markup.javadoc.parse_docstring
epydoc.markup.plaintext.parse_docstring
epydoc.markup.restructuredtext.parse_docstring" class="py-name" href="#" onclick="return doclink('link-79', 'parse_docstring', 'link-79');">parse_docstring</a></tt><tt class="py-op">(</tt><tt class="py-name">init_api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">suppress_warnings</tt><tt class="py-op">)</tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"> <tt id="link-80" class="py-name"><a title="epydoc.docstringparser.parse_function_signature" class="py-name" href="#" onclick="return doclink('link-80', 'parse_function_signature', 'link-64');">parse_function_signature</a></tt><tt class="py-op">(</tt><tt class="py-name">init_api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"> <tt id="link-81" class="py-name"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-81', 'docformat', 'link-61');">docformat</a></tt><tt class="py-op">,</tt> <tt class="py-name">parse_errors</tt><tt class="py-op">)</tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"> <tt class="py-name">init_fields</tt> <tt class="py-op">=</tt> <tt id="link-82" class="py-name" targets="Function epydoc.docstringparser.split_init_fields()=epydoc.docstringparser-module.html#split_init_fields"><a title="epydoc.docstringparser.split_init_fields" class="py-name" href="#" onclick="return doclink('link-82', 'split_init_fields', 'link-82');">split_init_fields</a></tt><tt class="py-op">(</tt><tt class="py-name">fields</tt><tt class="py-op">,</tt> <tt class="py-name">field_warnings</tt><tt class="py-op">)</tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"> <tt class="py-comment"># Process fields</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">init_fields</tt><tt class="py-op">:</tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"> <tt id="link-83" class="py-name" targets="Function epydoc.docstringparser.process_field()=epydoc.docstringparser-module.html#process_field"><a title="epydoc.docstringparser.process_field" class="py-name" href="#" onclick="return doclink('link-83', 'process_field', 'link-83');">process_field</a></tt><tt class="py-op">(</tt><tt class="py-name">init_api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name" targets="Method epydoc.markup.Field.tag()=epydoc.markup.Field-class.html#tag"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-84', 'tag', 'link-84');">tag</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name" targets="Method epydoc.markup.Field.arg()=epydoc.markup.Field-class.html#arg"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-85', 'arg', 'link-85');">arg</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-86" class="py-name" targets="Method epydoc.markup.Field.body()=epydoc.markup.Field-class.html#body"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-86', 'body', 'link-86');">body</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> <tt class="py-name">field_warnings</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> <tt class="py-comment"># Process fields</tt> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">fields</tt><tt class="py-op">:</tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"> <tt id="link-87" class="py-name"><a title="epydoc.docstringparser.process_field" class="py-name" href="#" onclick="return doclink('link-87', 'process_field', 'link-83');">process_field</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-88', 'tag', 'link-84');">tag</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-89" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-89', 'arg', 'link-85');">arg</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-90', 'body', 'link-86');">body</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> <tt class="py-name">field_warnings</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"> <tt class="py-comment"># Check to make sure that all type parameters correspond to</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># some documented parameter.</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-91" class="py-name" targets="Function epydoc.docstringparser.check_type_fields()=epydoc.docstringparser-module.html#check_type_fields"><a title="epydoc.docstringparser.check_type_fields" class="py-name" href="#" onclick="return doclink('link-91', 'check_type_fields', 'link-91');">check_type_fields</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">field_warnings</tt><tt class="py-op">)</tt> </tt>
<a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> <tt class="py-comment"># Check for special variables (e.g., __version__)</tt> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-92" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-92', 'NamespaceDoc', 'link-54');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt id="link-93" class="py-name"><a title="epydoc.docstringparser.STANDARD_FIELDS" class="py-name" href="#" onclick="return doclink('link-93', 'STANDARD_FIELDS', 'link-20');">STANDARD_FIELDS</a></tt> <tt class="py-op">+</tt> <tt id="link-94" class="py-name"><a title="epydoc.docstringparser.user_docfields" class="py-name" href="#" onclick="return doclink('link-94', 'user_docfields', 'link-56');">user_docfields</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> <tt id="link-95" class="py-name"><a title="epydoc.docstringparser.add_metadata_from_var" class="py-name" href="#" onclick="return doclink('link-95', 'add_metadata_from_var', 'link-57');">add_metadata_from_var</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">)</tt> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> <tt class="py-comment"># Extract a summary</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-96" class="py-name" targets="Variable epydoc.apidoc.APIDoc.summary=epydoc.apidoc.APIDoc-class.html#summary,Method epydoc.docwriter.html.HTMLWriter.summary()=epydoc.docwriter.html.HTMLWriter-class.html#summary,Method epydoc.markup.ConcatenatedDocstring.summary()=epydoc.markup.ConcatenatedDocstring-class.html#summary,Method epydoc.markup.ParsedDocstring.summary()=epydoc.markup.ParsedDocstring-class.html#summary,Method epydoc.markup.epytext.ParsedEpytextDocstring.summary()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#summary,Method epydoc.markup.javadoc.ParsedJavadocDocstring.summary()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#summary,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.summary()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#summary,Method epydoc.markup.restructuredtext.ParsedRstDocstring.summary()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#summary"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-96', 'summary', 'link-96');">summary</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-97" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-97', 'descr', 'link-70');">descr</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-98" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-98', 'summary', 'link-96');">summary</a></tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-99" class="py-name" targets="Variable epydoc.apidoc.APIDoc.other_docs=epydoc.apidoc.APIDoc-class.html#other_docs"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-99', 'other_docs', 'link-99');">other_docs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-100" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-100', 'descr', 'link-70');">descr</a></tt><tt class="py-op">.</tt><tt id="link-101" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-101', 'summary', 'link-96');">summary</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"> <tt class="py-comment"># If the summary is empty, but the return field is not, then use</tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the return field to generate a summary description.</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-102" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-102', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-103', 'summary', 'link-96');">summary</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-104" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_descr=epydoc.apidoc.RoutineDoc-class.html#return_descr,Method epydoc.docwriter.html.HTMLWriter.return_descr()=epydoc.docwriter.html.HTMLWriter-class.html#return_descr"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-104', 'return_descr', 'link-104');">return_descr</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> <tt class="py-name">s</tt><tt class="py-op">,</tt> <tt class="py-name">o</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-105', 'return_descr', 'link-104');">return_descr</a></tt><tt class="py-op">.</tt><tt id="link-106" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-106', 'summary', 'link-96');">summary</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-107" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-107', 'summary', 'link-96');">summary</a></tt> <tt class="py-op">=</tt> <tt id="link-108" class="py-name" targets="Variable epydoc.docstringparser.RETURN_PDS=epydoc.docstringparser-module.html#RETURN_PDS"><a title="epydoc.docstringparser.RETURN_PDS" class="py-name" href="#" onclick="return doclink('link-108', 'RETURN_PDS', 'link-108');">RETURN_PDS</a></tt> <tt class="py-op">+</tt> <tt class="py-name">s</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-109', 'other_docs', 'link-99');">other_docs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">o</tt> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"> <tt class="py-comment"># [XX] Make sure we don't have types/param descrs for unknown</tt> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># vars/params?</tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-comment"># Report any errors that occured</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">suppress_warnings</tt><tt class="py-op">:</tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parse_errors</tt> <tt class="py-keyword">or</tt> <tt class="py-name">field_warnings</tt><tt class="py-op">:</tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"> <tt id="link-110" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-110', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-111" class="py-name" targets="Function epydoc.log.info()=epydoc.log-module.html#info"><a title="epydoc.log.info" class="py-name" href="#" onclick="return doclink('link-111', 'info', 'link-111');">info</a></tt><tt class="py-op">(</tt><tt class="py-string">"Suppressing docstring warnings for %s, since it "</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"> <tt class="py-string">"is not included in the documented set."</tt> <tt class="py-op">%</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-112" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-112', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> <tt id="link-113" class="py-name" targets="Function epydoc.docstringparser.report_errors()=epydoc.docstringparser-module.html#report_errors"><a title="epydoc.docstringparser.report_errors" class="py-name" href="#" onclick="return doclink('link-113', 'report_errors', 'link-113');">report_errors</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">parse_errors</tt><tt class="py-op">,</tt> <tt class="py-name">field_warnings</tt><tt class="py-op">)</tt> </tt>
</div><a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> </tt>
<a name="add_metadata_from_var"></a><div id="add_metadata_from_var-def"><a name="L287"></a><tt class="py-lineno"> 287</tt> <a class="py-toggle" href="#" id="add_metadata_from_var-toggle" onclick="return toggle('add_metadata_from_var');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#add_metadata_from_var">add_metadata_from_var</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">field</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="add_metadata_from_var-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="add_metadata_from_var-expanded"><a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">varname</tt> <tt class="py-keyword">in</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">varnames</tt><tt class="py-op">:</tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-comment"># Check if api_doc has a variable w/ the given name.</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">varname</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-114" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-114', 'variables', 'link-75');">variables</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> <tt class="py-comment"># Check moved here from before the for loop because we expect to</tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># reach rarely this point. The loop below is to be performed more than</tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># once only for fields with more than one varname, which currently is</tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># only 'author'.</tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">md</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-115" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-115', 'metadata', 'link-44');">metadata</a></tt><tt class="py-op">:</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt> <tt class="py-op">==</tt> <tt class="py-name">md</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-comment"># We already have a value for this metadata.</tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-116', 'variables', 'link-75');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">varname</tt><tt class="py-op">]</tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-117" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-117', 'value', 'link-76');">value</a></tt> <tt class="py-keyword">is</tt> <tt id="link-118" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-118', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-119" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-119', 'value', 'link-76');">value</a></tt> </tt>
<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"> <tt id="link-120" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-120', 'value', 'link-76');">value</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"> <tt class="py-comment"># Try extracting the value from the pyval.</tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">ok_types</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">basestring</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">bool</tt><tt class="py-op">,</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-121" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.pyval=epydoc.apidoc.ValueDoc-class.html#pyval"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-121', 'pyval', 'link-121');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-122" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-122', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-123" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-123', 'pyval', 'link-121');">pyval</a></tt><tt class="py-op">,</tt> <tt class="py-name">ok_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"> <tt id="link-124" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-124', 'value', 'link-76');">value</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-125', 'pyval', 'link-121');">pyval</a></tt><tt class="py-op">]</tt> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">multivalue</tt><tt class="py-op">:</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-126" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-126', 'pyval', 'link-121');">pyval</a></tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">tuple</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">elt</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-127" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-127', 'pyval', 'link-121');">pyval</a></tt><tt class="py-op">:</tt> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">,</tt> <tt class="py-name">ok_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> <tt id="link-128" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-128', 'value', 'link-76');">value</a></tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-129" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-129', 'pyval', 'link-121');">pyval</a></tt><tt class="py-op">)</tt> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"> <tt class="py-comment"># Try extracting the value from the parse tree.</tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.toktree=epydoc.apidoc.ValueDoc-class.html#toktree"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-130', 'toktree', 'link-130');">toktree</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-131" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-131', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-132" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-132', 'value', 'link-76');">value</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-133" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-133', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="epydoc.docparser" class="py-name" href="#" onclick="return doclink('link-134', 'docparser', 'link-16');">docparser</a></tt><tt class="py-op">.</tt><tt id="link-135" class="py-name" targets="Function epydoc.docparser.parse_string()=epydoc.docparser-module.html#parse_string"><a title="epydoc.docparser.parse_string" class="py-name" href="#" onclick="return doclink('link-135', 'parse_string', 'link-135');">parse_string</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-136" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-136', 'toktree', 'link-130');">toktree</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">multivalue</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-137" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-137', 'value', 'link-76');">value</a></tt><tt class="py-op">:</tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-138" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-138', 'value', 'link-76');">value</a></tt> <tt class="py-op">=</tt> <tt id="link-139" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-139', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-140" class="py-name"><a title="epydoc.docparser" class="py-name" href="#" onclick="return doclink('link-140', 'docparser', 'link-16');">docparser</a></tt><tt class="py-op">.</tt><tt id="link-141" class="py-name" targets="Function epydoc.docparser.parse_string_list()=epydoc.docparser-module.html#parse_string_list"><a title="epydoc.docparser.parse_string_list" class="py-name" href="#" onclick="return doclink('link-141', 'parse_string_list', 'link-141');">parse_string_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-142" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-142', 'toktree', 'link-130');">toktree</a></tt><tt class="py-op">)</tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> <tt class="py-comment"># Add any values that we found.</tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">elt</tt> <tt class="py-keyword">in</tt> <tt id="link-143" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-143', 'value', 'link-76');">value</a></tt><tt class="py-op">:</tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"> <tt class="py-name">elt</tt> <tt class="py-op">=</tt> <tt id="link-144" class="py-name" targets="Function epydoc.util.decode_with_backslashreplace()=epydoc.util-module.html#decode_with_backslashreplace"><a title="epydoc.util.decode_with_backslashreplace" class="py-name" href="#" onclick="return doclink('link-144', 'decode_with_backslashreplace', 'link-144');">decode_with_backslashreplace</a></tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">)</tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-name">elt</tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">)</tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> <tt class="py-name">elt</tt> <tt class="py-op">=</tt> <tt id="link-145" class="py-name"><a title="epydoc.markup.epytext" class="py-name" href="#" onclick="return doclink('link-145', 'epytext', 'link-4');">epytext</a></tt><tt class="py-op">.</tt><tt id="link-146" class="py-name" targets="Class epydoc.markup.epytext.ParsedEpytextDocstring=epydoc.markup.epytext.ParsedEpytextDocstring-class.html"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-146', 'ParsedEpytextDocstring', 'link-146');">ParsedEpytextDocstring</a></tt><tt class="py-op">(</tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"> <tt id="link-147" class="py-name"><a title="epydoc.markup.epytext" class="py-name" href="#" onclick="return doclink('link-147', 'epytext', 'link-4');">epytext</a></tt><tt class="py-op">.</tt><tt id="link-148" class="py-name" targets="Function epydoc.markup.epytext.parse_as_para()=epydoc.markup.epytext-module.html#parse_as_para"><a title="epydoc.markup.epytext.parse_as_para" class="py-name" href="#" onclick="return doclink('link-148', 'parse_as_para', 'link-148');">parse_as_para</a></tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">inline</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> <tt class="py-comment"># Add in the metadata and remove from the variables</tt> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-149', 'metadata', 'link-44');">metadata</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt> <tt class="py-name">varname</tt><tt class="py-op">,</tt> <tt class="py-name">elt</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"> <tt class="py-comment"># Remove the variable itself (unless it's documented)</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-150" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-150', 'docstring', 'link-52');">docstring</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-151" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-151', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-152" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-152', 'variables', 'link-75');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">varname</tt><tt class="py-op">]</tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-153" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.sort_spec=epydoc.apidoc.NamespaceDoc-class.html#sort_spec"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-153', 'sort_spec', 'link-153');">sort_spec</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-154" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-154', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-155" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-155', 'sort_spec', 'link-153');">sort_spec</a></tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">varname</tt><tt class="py-op">)</tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"> </tt>
<a name="initialize_api_doc"></a><div id="initialize_api_doc-def"><a name="L346"></a><tt class="py-lineno"> 346</tt> <a class="py-toggle" href="#" id="initialize_api_doc-toggle" onclick="return toggle('initialize_api_doc');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#initialize_api_doc">initialize_api_doc</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="initialize_api_doc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="initialize_api_doc-expanded"><a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-docstring">"""A helper function for L{parse_docstring()} that initializes</tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"><tt class="py-docstring"> the attributes that C{parse_docstring()} will write to."""</tt> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-156" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-156', 'descr', 'link-70');">descr</a></tt> <tt class="py-keyword">is</tt> <tt id="link-157" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-157', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-158', 'descr', 'link-70');">descr</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-159" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-159', 'summary', 'link-96');">summary</a></tt> <tt class="py-keyword">is</tt> <tt id="link-160" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-160', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-161', 'summary', 'link-96');">summary</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-162" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-162', 'metadata', 'link-44');">metadata</a></tt> <tt class="py-keyword">is</tt> <tt id="link-163" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-163', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-164', 'metadata', 'link-44');">metadata</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-165" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-165', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-166" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_descrs=epydoc.apidoc.RoutineDoc-class.html#arg_descrs"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-166', 'arg_descrs', 'link-166');">arg_descrs</a></tt> <tt class="py-keyword">is</tt> <tt id="link-167" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-167', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-168', 'arg_descrs', 'link-166');">arg_descrs</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-169" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_types=epydoc.apidoc.RoutineDoc-class.html#arg_types"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-169', 'arg_types', 'link-169');">arg_types</a></tt> <tt class="py-keyword">is</tt> <tt id="link-170" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-170', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-171" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-171', 'arg_types', 'link-169');">arg_types</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-172" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-172', 'return_descr', 'link-104');">return_descr</a></tt> <tt class="py-keyword">is</tt> <tt id="link-173" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-173', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-174', 'return_descr', 'link-104');">return_descr</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-175" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_type=epydoc.apidoc.RoutineDoc-class.html#return_type,Method epydoc.docwriter.html.HTMLWriter.return_type()=epydoc.docwriter.html.HTMLWriter-class.html#return_type"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-175', 'return_type', 'link-175');">return_type</a></tt> <tt class="py-keyword">is</tt> <tt id="link-176" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-176', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-177" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-177', 'return_type', 'link-175');">return_type</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-178" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.exception_descrs=epydoc.apidoc.RoutineDoc-class.html#exception_descrs"><a title="epydoc.apidoc.RoutineDoc.exception_descrs" class="py-name" href="#" onclick="return doclink('link-178', 'exception_descrs', 'link-178');">exception_descrs</a></tt> <tt class="py-keyword">is</tt> <tt id="link-179" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-179', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-180" class="py-name"><a title="epydoc.apidoc.RoutineDoc.exception_descrs" class="py-name" href="#" onclick="return doclink('link-180', 'exception_descrs', 'link-178');">exception_descrs</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt id="link-181" class="py-name" targets="Class epydoc.apidoc.VariableDoc=epydoc.apidoc.VariableDoc-class.html"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-181', 'VariableDoc', 'link-181');">VariableDoc</a></tt><tt class="py-op">,</tt> <tt id="link-182" class="py-name" targets="Class epydoc.apidoc.PropertyDoc=epydoc.apidoc.PropertyDoc-class.html"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-182', 'PropertyDoc', 'link-182');">PropertyDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-183" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.type_descr=epydoc.apidoc.PropertyDoc-class.html#type_descr,Variable epydoc.apidoc.VariableDoc.type_descr=epydoc.apidoc.VariableDoc-class.html#type_descr,Method epydoc.docwriter.html.HTMLWriter.type_descr()=epydoc.docwriter.html.HTMLWriter-class.html#type_descr"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-183', 'type_descr', 'link-183');">type_descr</a></tt> <tt class="py-keyword">is</tt> <tt id="link-184" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-184', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-185" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-185', 'type_descr', 'link-183');">type_descr</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-186" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-186', 'NamespaceDoc', 'link-54');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-187" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.group_specs=epydoc.apidoc.NamespaceDoc-class.html#group_specs"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-187', 'group_specs', 'link-187');">group_specs</a></tt> <tt class="py-keyword">is</tt> <tt id="link-188" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-188', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-189" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-189', 'group_specs', 'link-187');">group_specs</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-190" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-190', 'sort_spec', 'link-153');">sort_spec</a></tt> <tt class="py-keyword">is</tt> <tt id="link-191" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-191', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-192" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-192', 'sort_spec', 'link-153');">sort_spec</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"> </tt>
<a name="split_init_fields"></a><div id="split_init_fields-def"><a name="L375"></a><tt class="py-lineno"> 375</tt> <a class="py-toggle" href="#" id="split_init_fields-toggle" onclick="return toggle('split_init_fields');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#split_init_fields">split_init_fields</a><tt class="py-op">(</tt><tt class="py-param">fields</tt><tt class="py-op">,</tt> <tt class="py-param">warnings</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="split_init_fields-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="split_init_fields-expanded"><a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"><tt class="py-docstring"> Remove the fields related to the constructor from a class docstring</tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"><tt class="py-docstring"> fields list.</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"><tt class="py-docstring"> @param fields: The fields to process. The list will be modified in place</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"><tt class="py-docstring"> @type fields: C{list} of L{markup.Field}</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"><tt class="py-docstring"> @param warnings: A list to emit processing warnings</tt> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"><tt class="py-docstring"> @type warnings: C{list}</tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"><tt class="py-docstring"> @return: The C{fields} items to be applied to the C{__init__} method</tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{list} of L{markup.Field}</tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"> <tt class="py-name">init_fields</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"> <tt class="py-comment"># Split fields in lists according to their argument, keeping order.</tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">arg_fields</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> <tt class="py-name">args_order</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-name">i</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">i</tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">fields</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> <tt class="py-name">field</tt> <tt class="py-op">=</tt> <tt class="py-name">fields</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"> <tt class="py-comment"># gather together all the fields with the same arg</tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-193" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-193', 'arg', 'link-85');">arg</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"> <tt class="py-name">arg_fields</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-194" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-194', 'arg', 'link-85');">arg</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">fields</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> <tt class="py-name">args_order</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-195" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-195', 'arg', 'link-85');">arg</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt class="py-name">i</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"> <tt class="py-comment"># Now check that for each argument there is at most a single variable</tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and a single parameter, and at most a single type for each of them.</tt> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt id="link-196" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-196', 'arg', 'link-85');">arg</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">args_order</tt><tt class="py-op">:</tt> </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"> <tt class="py-name">ff</tt> <tt class="py-op">=</tt> <tt class="py-name">arg_fields</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt id="link-197" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-197', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ff</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> </tt>
<a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> <tt class="py-name">var</tt> <tt class="py-op">=</tt> <tt class="py-name">tvar</tt> <tt class="py-op">=</tt> <tt class="py-name">par</tt> <tt class="py-op">=</tt> <tt class="py-name">tpar</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">ff</tt><tt class="py-op">:</tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-198" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-198', 'tag', 'link-84');">tag</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt id="link-199" class="py-name" targets="Variable epydoc.docstringparser.VARIABLE_TAGS=epydoc.docstringparser-module.html#VARIABLE_TAGS"><a title="epydoc.docstringparser.VARIABLE_TAGS" class="py-name" href="#" onclick="return doclink('link-199', 'VARIABLE_TAGS', 'link-199');">VARIABLE_TAGS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"> <tt class="py-name">var</tt> <tt class="py-op">=</tt> <tt class="py-name">field</tt> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"> <tt class="py-name">fields</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">)</tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"> <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> <tt class="py-string">"There is more than one variable named '%s'"</tt> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt id="link-200" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-200', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-201" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-201', 'tag', 'link-84');">tag</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt id="link-202" class="py-name" targets="Variable epydoc.docstringparser.PARAMETER_TAGS=epydoc.docstringparser-module.html#PARAMETER_TAGS"><a title="epydoc.docstringparser.PARAMETER_TAGS" class="py-name" href="#" onclick="return doclink('link-202', 'PARAMETER_TAGS', 'link-202');">PARAMETER_TAGS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">par</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"> <tt class="py-name">par</tt> <tt class="py-op">=</tt> <tt class="py-name">field</tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"> <tt class="py-name">init_fields</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">)</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"> <tt class="py-name">warnings</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"> <tt class="py-string">"There is more than one parameter named '%s'"</tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt id="link-203" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-203', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"> </tt>
<a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-204', 'tag', 'link-84');">tag</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-string">'type'</tt><tt class="py-op">:</tt> </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">par</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"> <tt class="py-comment"># type before obj</tt> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">tvar</tt> <tt class="py-op">=</tt> <tt class="py-name">tpar</tt> <tt class="py-op">=</tt> <tt class="py-name">field</tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">tvar</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> <tt class="py-name">tvar</tt> <tt class="py-op">=</tt> <tt class="py-name">field</tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">par</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">tpar</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"> <tt class="py-name">tpar</tt> <tt class="py-op">=</tt> <tt class="py-name">field</tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-205" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-205', 'tag', 'link-84');">tag</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt id="link-206" class="py-name" targets="Variable epydoc.docstringparser.EXCEPTION_TAGS=epydoc.docstringparser-module.html#EXCEPTION_TAGS"><a title="epydoc.docstringparser.EXCEPTION_TAGS" class="py-name" href="#" onclick="return doclink('link-206', 'EXCEPTION_TAGS', 'link-206');">EXCEPTION_TAGS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> <tt class="py-name">init_fields</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">)</tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-comment"># Unespected field</tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"> <tt class="py-name">fields</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">)</tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"> <tt class="py-comment"># Put selected types into the proper output lists</tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">tvar</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"> <tt class="py-name">fields</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">tvar</tt><tt class="py-op">)</tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> <tt class="py-comment"># [xx] warn about type w/o object?</tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tpar</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">par</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-name">init_fields</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">tpar</tt><tt class="py-op">)</tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> <tt class="py-comment"># [xx] warn about type w/o object?</tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">init_fields</tt> </tt>
</div><a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"> </tt>
<a name="report_errors"></a><div id="report_errors-def"><a name="L460"></a><tt class="py-lineno"> 460</tt> <a class="py-toggle" href="#" id="report_errors-toggle" onclick="return toggle('report_errors');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#report_errors">report_errors</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">parse_errors</tt><tt class="py-op">,</tt> <tt class="py-param">field_warnings</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="report_errors-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="report_errors-expanded"><a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"> <tt class="py-docstring">"""A helper function for L{parse_docstring()} that reports any</tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-docstring"> markup warnings and field warnings that we encountered while</tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"><tt class="py-docstring"> processing C{api_doc}'s docstring."""</tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">parse_errors</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">field_warnings</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"> <tt class="py-comment"># Get the name of the item containing the error, and the</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># filename of its containing module.</tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-207" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.name=epydoc.apidoc.VariableDoc-class.html#name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-207', 'name', 'link-207');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-208" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-208', 'canonical_name', 'link-47');">canonical_name</a></tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-209" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.defining_module=epydoc.apidoc.ValueDoc-class.html#defining_module,Variable epydoc.apidoc.VariableDoc.defining_module=epydoc.apidoc.VariableDoc-class.html#defining_module"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-209', 'defining_module', 'link-209');">defining_module</a></tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-210" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-210', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-211" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.filename=epydoc.apidoc.ModuleDoc-class.html#filename"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-211', 'filename', 'link-211');">filename</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-212" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-212', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-213" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-213', 'filename', 'link-211');">filename</a></tt> <tt class="py-op">=</tt> <tt id="link-214" class="py-name"><a title="epydoc.util.py_src_filename" class="py-name" href="#" onclick="return doclink('link-214', 'py_src_filename', 'link-12');">py_src_filename</a></tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-215" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-215', 'filename', 'link-211');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt id="link-216" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-216', 'filename', 'link-211');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-217" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-217', 'filename', 'link-211');">filename</a></tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt id="link-218" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-218', 'filename', 'link-211');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'??'</tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> <tt class="py-comment"># [xx] Don't report markup errors for standard builtins.</tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># n.b. that we must use 'is' to compare pyvals here -- if we use</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 'in' or '==', then a user __cmp__ method might raise an</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># exception, or lie.</tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-219" class="py-name" targets="Class epydoc.apidoc.ValueDoc=epydoc.apidoc.ValueDoc-class.html"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-219', 'ValueDoc', 'link-219');">ValueDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">api_doc</tt> <tt class="py-op">!=</tt> <tt class="py-name">module</tt><tt class="py-op">:</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-220" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-220', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-221" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-221', 'pyval', 'link-121');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">exceptions</tt><tt class="py-op">:</tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">builtin_val</tt> <tt class="py-keyword">in</tt> <tt class="py-name">__builtin__</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">builtin_val</tt> <tt class="py-keyword">is</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-222" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-222', 'pyval', 'link-121');">pyval</a></tt><tt class="py-op">:</tt> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> <tt class="py-comment"># Get the start line of the docstring containing the error.</tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">startline</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-223" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docstring_lineno=epydoc.apidoc.APIDoc-class.html#docstring_lineno"><a title="epydoc.apidoc.APIDoc.docstring_lineno" class="py-name" href="#" onclick="return doclink('link-223', 'docstring_lineno', 'link-223');">docstring_lineno</a></tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">startline</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-224" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-224', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> <tt class="py-name">startline</tt> <tt class="py-op">=</tt> <tt id="link-225" class="py-name"><a title="epydoc.docintrospecter.introspect_docstring_lineno" class="py-name" href="#" onclick="return doclink('link-225', 'introspect_docstring_lineno', 'link-9');">introspect_docstring_lineno</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">startline</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-226" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-226', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"> <tt class="py-name">startline</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"> <tt class="py-comment"># Display a block header.</tt> </tt>
<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">header</tt> <tt class="py-op">=</tt> <tt class="py-string">'File %s, '</tt> <tt class="py-op">%</tt> <tt id="link-227" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-227', 'filename', 'link-211');">filename</a></tt> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">startline</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"> <tt class="py-name">header</tt> <tt class="py-op">+=</tt> <tt class="py-string">'line %d, '</tt> <tt class="py-op">%</tt> <tt class="py-name">startline</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"> <tt class="py-name">header</tt> <tt class="py-op">+=</tt> <tt class="py-string">'in %s'</tt> <tt class="py-op">%</tt> <tt id="link-228" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-228', 'name', 'link-207');">name</a></tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"> <tt id="link-229" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-229', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-230" class="py-name" targets="Method epydoc.cli.ConsoleLogger.start_block()=epydoc.cli.ConsoleLogger-class.html#start_block,Method epydoc.cli.HTMLLogger.start_block()=epydoc.cli.HTMLLogger-class.html#start_block,Method epydoc.gui.GUILogger.start_block()=epydoc.gui.GUILogger-class.html#start_block,Method epydoc.log.Logger.start_block()=epydoc.log.Logger-class.html#start_block,Function epydoc.log.start_block()=epydoc.log-module.html#start_block"><a title="epydoc.cli.ConsoleLogger.start_block
epydoc.cli.HTMLLogger.start_block
epydoc.gui.GUILogger.start_block
epydoc.log.Logger.start_block
epydoc.log.start_block" class="py-name" href="#" onclick="return doclink('link-230', 'start_block', 'link-230');">start_block</a></tt><tt class="py-op">(</tt><tt class="py-name">header</tt><tt class="py-op">)</tt> </tt>
<a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> <tt class="py-comment"># Display all parse errors. But first, combine any errors</tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># with duplicate description messages.</tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">startline</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"> <tt class="py-comment"># remove dups, but keep original order:</tt> </tt>
<a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">dups</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-231" class="py-name" targets="Function epydoc.log.error()=epydoc.log-module.html#error"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-231', 'error', 'link-231');">error</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">parse_errors</tt><tt class="py-op">:</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"> <tt class="py-name">message</tt> <tt class="py-op">=</tt> <tt id="link-232" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-232', 'error', 'link-231');">error</a></tt><tt class="py-op">.</tt><tt id="link-233" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-233', 'descr', 'link-70');">descr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">message</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dups</tt><tt class="py-op">:</tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"> <tt id="link-234" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-234', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-235" class="py-name" targets="Function epydoc.log.docstring_warning()=epydoc.log-module.html#docstring_warning"><a title="epydoc.log.docstring_warning" class="py-name" href="#" onclick="return doclink('link-235', 'docstring_warning', 'link-235');">docstring_warning</a></tt><tt class="py-op">(</tt><tt class="py-name">message</tt><tt class="py-op">)</tt> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"> <tt class="py-name">dups</tt><tt class="py-op">[</tt><tt class="py-name">message</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"> <tt class="py-comment"># Combine line number fields for dup messages:</tt> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">messages</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> <tt class="py-comment"># maps message -> list of linenum</tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-236" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-236', 'error', 'link-231');">error</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">parse_errors</tt><tt class="py-op">:</tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"> <tt id="link-237" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-237', 'error', 'link-231');">error</a></tt><tt class="py-op">.</tt><tt id="link-238" class="py-name" targets="Method epydoc.markup.ParseError.set_linenum_offset()=epydoc.markup.ParseError-class.html#set_linenum_offset"><a title="epydoc.markup.ParseError.set_linenum_offset" class="py-name" href="#" onclick="return doclink('link-238', 'set_linenum_offset', 'link-238');">set_linenum_offset</a></tt><tt class="py-op">(</tt><tt class="py-name">startline</tt><tt class="py-op">)</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"> <tt class="py-name">message</tt> <tt class="py-op">=</tt> <tt id="link-239" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-239', 'error', 'link-231');">error</a></tt><tt class="py-op">.</tt><tt id="link-240" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-240', 'descr', 'link-70');">descr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"> <tt class="py-name">messages</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">message</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-241" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-241', 'error', 'link-231');">error</a></tt><tt class="py-op">.</tt><tt id="link-242" class="py-name" targets="Method epydoc.markup.ParseError.linenum()=epydoc.markup.ParseError-class.html#linenum"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-242', 'linenum', 'link-242');">linenum</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"> <tt class="py-name">message_items</tt> <tt class="py-op">=</tt> <tt class="py-name">messages</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"> <tt class="py-name">message_items</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-keyword">lambda</tt> <tt class="py-name">a</tt><tt class="py-op">,</tt><tt class="py-name">b</tt><tt class="py-op">:</tt><tt class="py-name">cmp</tt><tt class="py-op">(</tt><tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">a</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">b</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">message</tt><tt class="py-op">,</tt> <tt class="py-name">linenums</tt> <tt class="py-keyword">in</tt> <tt class="py-name">message_items</tt><tt class="py-op">:</tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"> <tt class="py-name">linenums</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">n</tt> <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt class="py-name">linenums</tt> <tt class="py-keyword">if</tt> <tt class="py-name">n</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">]</tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">linenums</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"> <tt id="link-243" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-243', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-244" class="py-name"><a title="epydoc.log.docstring_warning" class="py-name" href="#" onclick="return doclink('link-244', 'docstring_warning', 'link-235');">docstring_warning</a></tt><tt class="py-op">(</tt><tt class="py-name">message</tt><tt class="py-op">)</tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">linenums</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"> <tt id="link-245" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-245', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-246" class="py-name"><a title="epydoc.log.docstring_warning" class="py-name" href="#" onclick="return doclink('link-246', 'docstring_warning', 'link-235');">docstring_warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Line %s: %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">linenums</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"> <tt class="py-name">linenums</tt> <tt class="py-op">=</tt> <tt class="py-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">l</tt> <tt class="py-keyword">for</tt> <tt class="py-name">l</tt> <tt class="py-keyword">in</tt> <tt class="py-name">linenums</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"> <tt id="link-247" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-247', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-248" class="py-name"><a title="epydoc.log.docstring_warning" class="py-name" href="#" onclick="return doclink('link-248', 'docstring_warning', 'link-235');">docstring_warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Lines %s: %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">linenums</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"> <tt class="py-comment"># Display all field warnings.</tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt id="link-249" class="py-name" targets="Method epydoc.checker.DocChecker.warning()=epydoc.checker.DocChecker-class.html#warning,Function epydoc.log.warning()=epydoc.log-module.html#warning"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-249', 'warning', 'link-249');">warning</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">field_warnings</tt><tt class="py-op">:</tt> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> <tt id="link-250" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-250', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-251" class="py-name"><a title="epydoc.log.docstring_warning" class="py-name" href="#" onclick="return doclink('link-251', 'docstring_warning', 'link-235');">docstring_warning</a></tt><tt class="py-op">(</tt><tt id="link-252" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-252', 'warning', 'link-249');">warning</a></tt><tt class="py-op">)</tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"> <tt class="py-comment"># End the message block.</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-253" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-253', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-254" class="py-name" targets="Method epydoc.cli.ConsoleLogger.end_block()=epydoc.cli.ConsoleLogger-class.html#end_block,Method epydoc.cli.HTMLLogger.end_block()=epydoc.cli.HTMLLogger-class.html#end_block,Method epydoc.gui.GUILogger.end_block()=epydoc.gui.GUILogger-class.html#end_block,Method epydoc.log.Logger.end_block()=epydoc.log.Logger-class.html#end_block,Function epydoc.log.end_block()=epydoc.log-module.html#end_block"><a title="epydoc.cli.ConsoleLogger.end_block
epydoc.cli.HTMLLogger.end_block
epydoc.gui.GUILogger.end_block
epydoc.log.Logger.end_block
epydoc.log.end_block" class="py-name" href="#" onclick="return doclink('link-254', 'end_block', 'link-254');">end_block</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"><tt id="link-255" class="py-name"><a title="epydoc.docstringparser.RETURN_PDS" class="py-name" href="#" onclick="return doclink('link-255', 'RETURN_PDS', 'link-108');">RETURN_PDS</a></tt> <tt class="py-op">=</tt> <tt id="link-256" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-256', 'markup', 'link-1');">markup</a></tt><tt class="py-op">.</tt><tt id="link-257" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-257', 'parse', 'link-67');">parse</a></tt><tt class="py-op">(</tt><tt class="py-string">'Returns:'</tt><tt class="py-op">,</tt> <tt id="link-258" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-258', 'markup', 'link-1');">markup</a></tt><tt class="py-op">=</tt><tt class="py-string">'epytext'</tt><tt class="py-op">)</tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"><tt class="py-string">"""A ParsedDocstring containing the text 'Returns'. This is used to</tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"><tt class="py-string">construct summary descriptions for routines that have empty C{descr},</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"><tt class="py-string">but non-empty C{return_descr}."""</tt> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"><tt id="link-259" class="py-name"><a title="epydoc.docstringparser.RETURN_PDS" class="py-name" href="#" onclick="return doclink('link-259', 'RETURN_PDS', 'link-108');">RETURN_PDS</a></tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">[</tt><tt class="py-string">'inline'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Field Processing Error Messages</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"><tt id="link-260" class="py-name" targets="Variable epydoc.docstringparser.UNEXPECTED_ARG=epydoc.docstringparser-module.html#UNEXPECTED_ARG"><a title="epydoc.docstringparser.UNEXPECTED_ARG" class="py-name" href="#" onclick="return doclink('link-260', 'UNEXPECTED_ARG', 'link-260');">UNEXPECTED_ARG</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%r did not expect an argument'</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"><tt id="link-261" class="py-name" targets="Variable epydoc.docstringparser.EXPECTED_ARG=epydoc.docstringparser-module.html#EXPECTED_ARG"><a title="epydoc.docstringparser.EXPECTED_ARG" class="py-name" href="#" onclick="return doclink('link-261', 'EXPECTED_ARG', 'link-261');">EXPECTED_ARG</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%r expected an argument'</tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"><tt id="link-262" class="py-name" targets="Variable epydoc.docstringparser.EXPECTED_SINGLE_ARG=epydoc.docstringparser-module.html#EXPECTED_SINGLE_ARG"><a title="epydoc.docstringparser.EXPECTED_SINGLE_ARG" class="py-name" href="#" onclick="return doclink('link-262', 'EXPECTED_SINGLE_ARG', 'link-262');">EXPECTED_SINGLE_ARG</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%r expected a single argument'</tt> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"><tt id="link-263" class="py-name" targets="Variable epydoc.docstringparser.BAD_CONTEXT=epydoc.docstringparser-module.html#BAD_CONTEXT"><a title="epydoc.docstringparser.BAD_CONTEXT" class="py-name" href="#" onclick="return doclink('link-263', 'BAD_CONTEXT', 'link-263');">BAD_CONTEXT</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'Invalid context for %r'</tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"><tt id="link-264" class="py-name" targets="Variable epydoc.docstringparser.REDEFINED=epydoc.docstringparser-module.html#REDEFINED"><a title="epydoc.docstringparser.REDEFINED" class="py-name" href="#" onclick="return doclink('link-264', 'REDEFINED', 'link-264');">REDEFINED</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'Redefinition of %s'</tt> </tt>
<a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"><tt id="link-265" class="py-name" targets="Variable epydoc.docstringparser.UNKNOWN_TAG=epydoc.docstringparser-module.html#UNKNOWN_TAG"><a title="epydoc.docstringparser.UNKNOWN_TAG" class="py-name" href="#" onclick="return doclink('link-265', 'UNKNOWN_TAG', 'link-265');">UNKNOWN_TAG</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'Unknown field tag %r'</tt> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"><tt id="link-266" class="py-name" targets="Variable epydoc.docstringparser.BAD_PARAM=epydoc.docstringparser-module.html#BAD_PARAM"><a title="epydoc.docstringparser.BAD_PARAM" class="py-name" href="#" onclick="return doclink('link-266', 'BAD_PARAM', 'link-266');">BAD_PARAM</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'@%s for unknown parameter %s'</tt> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Field Processing</tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_field"></a><div id="process_field-def"><a name="L560"></a><tt class="py-lineno"> 560</tt> <a class="py-toggle" href="#" id="process_field-toggle" onclick="return toggle('process_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_field">process_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_field-expanded"><a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"><tt class="py-docstring"> Process a single field, and use it to update C{api_doc}. If</tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"><tt class="py-docstring"> C{tag} is the name of a special field, then call its handler</tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"><tt class="py-docstring"> function. If C{tag} is the name of a simple field, then use</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"><tt class="py-docstring"> C{process_simple_field} to process it. Otherwise, check if it's a</tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"><tt class="py-docstring"> user-defined field, defined in this docstring or the docstring of</tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"><tt class="py-docstring"> a containing object; and if so, process it with</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"><tt class="py-docstring"> C{process_simple_field}.</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"><tt class="py-docstring"> @param tag: The field's tag, such as C{'author'}</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"><tt class="py-docstring"> @param arg: The field's optional argument</tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"><tt class="py-docstring"> @param descr: The description following the field tag and</tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"><tt class="py-docstring"> argument.</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"><tt class="py-docstring"> @raise ValueError: If a problem was encountered while processing</tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"><tt class="py-docstring"> the field. The C{ValueError}'s string argument is an</tt> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"><tt class="py-docstring"> explanation of the problem, which should be displayed as a</tt> </tt>
<a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"><tt class="py-docstring"> warning message.</tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> <tt class="py-comment"># standard special fields</tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-267" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-267', 'tag', 'link-84');">tag</a></tt> <tt class="py-keyword">in</tt> <tt id="link-268" class="py-name" targets="Variable epydoc.docstringparser._field_dispatch_table=epydoc.docstringparser-module.html#_field_dispatch_table"><a title="epydoc.docstringparser._field_dispatch_table" class="py-name" href="#" onclick="return doclink('link-268', '_field_dispatch_table', 'link-268');">_field_dispatch_table</a></tt><tt class="py-op">:</tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-name">handler</tt> <tt class="py-op">=</tt> <tt id="link-269" class="py-name"><a title="epydoc.docstringparser._field_dispatch_table" class="py-name" href="#" onclick="return doclink('link-269', '_field_dispatch_table', 'link-268');">_field_dispatch_table</a></tt><tt class="py-op">[</tt><tt id="link-270" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-270', 'tag', 'link-84');">tag</a></tt><tt class="py-op">]</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> <tt class="py-name">handler</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt id="link-271" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-271', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-272" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-272', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-273" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-273', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> <tt class="py-comment"># standard simple fields & user-defined fields</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt id="link-274" class="py-name"><a title="epydoc.docstringparser.STANDARD_FIELDS" class="py-name" href="#" onclick="return doclink('link-274', 'STANDARD_FIELDS', 'link-20');">STANDARD_FIELDS</a></tt> <tt class="py-op">+</tt> <tt id="link-275" class="py-name"><a title="epydoc.docstringparser.user_docfields" class="py-name" href="#" onclick="return doclink('link-275', 'user_docfields', 'link-56');">user_docfields</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-276" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-276', 'tag', 'link-84');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">tags</tt><tt class="py-op">:</tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"> <tt class="py-comment"># [xx] check if it's redefined if it's not multivalue??</tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">takes_arg</tt><tt class="py-op">:</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"> <tt id="link-277" class="py-name" targets="Method epydoc.checker.DocChecker._check()=epydoc.checker.DocChecker-class.html#_check,Function epydoc.docstringparser._check()=epydoc.docstringparser-module.html#_check"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-277', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-278" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-278', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-279" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-279', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-280" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-280', 'metadata', 'link-44');">metadata</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt> <tt id="link-281" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-281', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-282" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-282', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt class="py-comment"># If we didn't handle the field, then report a warning.</tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-283" class="py-name"><a title="epydoc.docstringparser.UNKNOWN_TAG" class="py-name" href="#" onclick="return doclink('link-283', 'UNKNOWN_TAG', 'link-265');">UNKNOWN_TAG</a></tt> <tt class="py-op">%</tt> <tt id="link-284" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-284', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"> </tt>
<a name="user_docfields"></a><div id="user_docfields-def"><a name="L597"></a><tt class="py-lineno"> 597</tt> <a class="py-toggle" href="#" id="user_docfields-toggle" onclick="return toggle('user_docfields');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#user_docfields">user_docfields</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="user_docfields-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="user_docfields-expanded"><a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"><tt class="py-docstring"> Return a list of user defined fields that can be used for the</tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"><tt class="py-docstring"> given object. This list is taken from the given C{api_doc}, and</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"><tt class="py-docstring"> any of its containing C{NamepaceDoc}s.</tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"><tt class="py-docstring"> @note: We assume here that a parent's docstring will always be</tt> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"><tt class="py-docstring"> parsed before its childrens'. This is indeed the case when we</tt> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"><tt class="py-docstring"> are called via L{docbuilder.build_doc_index()}. If a child's</tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"><tt class="py-docstring"> docstring is parsed before its parents, then its parent won't</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"><tt class="py-docstring"> yet have had its C{extra_docstring_fields} attribute</tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"><tt class="py-docstring"> initialized.</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"> <tt class="py-name">docfields</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> <tt class="py-comment"># Get any docfields from `api_doc` itself</tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-285" class="py-name" targets="Variable epydoc.apidoc.APIDoc.extra_docstring_fields=epydoc.apidoc.APIDoc-class.html#extra_docstring_fields"><a title="epydoc.apidoc.APIDoc.extra_docstring_fields" class="py-name" href="#" onclick="return doclink('link-285', 'extra_docstring_fields', 'link-285');">extra_docstring_fields</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-286" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-286', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"> <tt class="py-name">docfields</tt> <tt class="py-op">+=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-287" class="py-name"><a title="epydoc.apidoc.APIDoc.extra_docstring_fields" class="py-name" href="#" onclick="return doclink('link-287', 'extra_docstring_fields', 'link-285');">extra_docstring_fields</a></tt> </tt>
<a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"> <tt class="py-comment"># Get any docfields from `api_doc`'s ancestors</tt> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-288" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-288', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> <tt class="py-name">ancestor</tt> <tt class="py-op">=</tt> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-289" class="py-name" targets="Method epydoc.apidoc.DocIndex.get_valdoc()=epydoc.apidoc.DocIndex-class.html#get_valdoc"><a title="epydoc.apidoc.DocIndex.get_valdoc" class="py-name" href="#" onclick="return doclink('link-289', 'get_valdoc', 'link-289');">get_valdoc</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-290" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-290', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ancestor</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> \ </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">ancestor</tt><tt class="py-op">.</tt><tt id="link-291" class="py-name"><a title="epydoc.apidoc.APIDoc.extra_docstring_fields" class="py-name" href="#" onclick="return doclink('link-291', 'extra_docstring_fields', 'link-285');">extra_docstring_fields</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-292" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-292', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"> <tt class="py-name">docfields</tt> <tt class="py-op">+=</tt> <tt class="py-name">ancestor</tt><tt class="py-op">.</tt><tt id="link-293" class="py-name"><a title="epydoc.apidoc.APIDoc.extra_docstring_fields" class="py-name" href="#" onclick="return doclink('link-293', 'extra_docstring_fields', 'link-285');">extra_docstring_fields</a></tt> </tt>
<a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">docfields</tt> </tt>
</div><a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"><tt id="link-294" class="py-name"><a title="epydoc.docstringparser._field_dispatch_table" class="py-name" href="#" onclick="return doclink('link-294', '_field_dispatch_table', 'link-268');">_field_dispatch_table</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="register_field_handler"></a><div id="register_field_handler-def"><a name="L623"></a><tt class="py-lineno"> 623</tt> <a class="py-toggle" href="#" id="register_field_handler-toggle" onclick="return toggle('register_field_handler');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#register_field_handler">register_field_handler</a><tt class="py-op">(</tt><tt class="py-param">handler</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">field_tags</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="register_field_handler-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="register_field_handler-expanded"><a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"><tt class="py-docstring"> Register the given field handler function for processing any</tt> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"><tt class="py-docstring"> of the given field tags. Field handler functions should</tt> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"><tt class="py-docstring"> have the following signature:</tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"><tt class="py-docstring"> >>> def field_handler(api_doc, docindex, tag, arg, descr):</tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"><tt class="py-docstring"> ... '''update api_doc in response to the field.'''</tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"><tt class="py-docstring"> Where C{api_doc} is the documentation object to update;</tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"><tt class="py-docstring"> C{docindex} is a L{DocIndex} that can be used to look up the</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"><tt class="py-docstring"> documentation for related objects; C{tag} is the field tag that</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"><tt class="py-docstring"> was used; C{arg} is the optional argument; and C{descr} is the</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"><tt class="py-docstring"> description following the field tag and argument.</tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">field_tag</tt> <tt class="py-keyword">in</tt> <tt class="py-name">field_tags</tt><tt class="py-op">:</tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"> <tt id="link-295" class="py-name"><a title="epydoc.docstringparser._field_dispatch_table" class="py-name" href="#" onclick="return doclink('link-295', '_field_dispatch_table', 'link-268');">_field_dispatch_table</a></tt><tt class="py-op">[</tt><tt class="py-name">field_tag</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">handler</tt> </tt>
</div><a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Field Handler Functions</tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_summary_field"></a><div id="process_summary_field-def"><a name="L645"></a><tt class="py-lineno"> 645</tt> <a class="py-toggle" href="#" id="process_summary_field-toggle" onclick="return toggle('process_summary_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_summary_field">process_summary_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_summary_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_summary_field-expanded"><a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"> <tt class="py-docstring">"""Store C{descr} in C{api_doc.summary}"""</tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"> <tt id="link-296" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-296', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-297" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-297', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-298" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-298', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-299" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-299', 'summary', 'link-96');">summary</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-300" class="py-name"><a title="epydoc.docstringparser.REDEFINED" class="py-name" href="#" onclick="return doclink('link-300', 'REDEFINED', 'link-264');">REDEFINED</a></tt> <tt class="py-op">%</tt> <tt id="link-301" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-301', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-302" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-302', 'summary', 'link-96');">summary</a></tt> <tt class="py-op">=</tt> <tt id="link-303" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-303', 'descr', 'link-70');">descr</a></tt> </tt>
</div><a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> </tt>
<a name="process_include_field"></a><div id="process_include_field-def"><a name="L652"></a><tt class="py-lineno"> 652</tt> <a class="py-toggle" href="#" id="process_include_field-toggle" onclick="return toggle('process_include_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_include_field">process_include_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_include_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_include_field-expanded"><a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt class="py-docstring">"""Copy the docstring contents from the object named in C{descr}"""</tt> </tt>
<a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"> <tt id="link-304" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-304', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-305" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-305', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-306" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-306', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> <tt class="py-comment"># options:</tt> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># a. just append the descr to our own</tt> </tt>
<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># b. append descr and update metadata</tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># c. append descr and process all fields.</tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># in any case, mark any errors we may find as coming from an</tt> </tt>
<a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># imported docstring.</tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-comment"># how does this interact with documentation inheritance??</tt> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'%s not implemented yet'</tt> <tt class="py-op">%</tt> <tt id="link-307" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-307', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"> </tt>
<a name="process_undocumented_field"></a><div id="process_undocumented_field-def"><a name="L665"></a><tt class="py-lineno"> 665</tt> <a class="py-toggle" href="#" id="process_undocumented_field-toggle" onclick="return toggle('process_undocumented_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_undocumented_field">process_undocumented_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_undocumented_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_undocumented_field-expanded"><a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"> <tt class="py-docstring">"""Remove any documentation for the variables named in C{descr}"""</tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> <tt id="link-308" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-308', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-309" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-309', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-310" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-310', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-311" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-311', 'NamespaceDoc', 'link-54');">NamespaceDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt id="link-312" class="py-name" targets="Function epydoc.docstringparser._descr_to_identifiers()=epydoc.docstringparser-module.html#_descr_to_identifiers"><a title="epydoc.docstringparser._descr_to_identifiers" class="py-name" href="#" onclick="return doclink('link-312', '_descr_to_identifiers', 'link-312');">_descr_to_identifiers</a></tt><tt class="py-op">(</tt><tt id="link-313" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-313', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"> <tt class="py-name">var_name_re</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'^%s$'</tt> <tt class="py-op">%</tt> <tt class="py-name">ident</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'*'</tt><tt class="py-op">,</tt> <tt class="py-string">'(.*)'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_name</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-314" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-314', 'variables', 'link-75');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_name_re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">var_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> <tt class="py-comment"># Remove the variable from `variables`.</tt> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-315" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-315', 'variables', 'link-75');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-name">var_name</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-316" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-316', 'sort_spec', 'link-153');">sort_spec</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-317" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-317', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-318" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-318', 'sort_spec', 'link-153');">sort_spec</a></tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">var_name</tt><tt class="py-op">)</tt> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"> <tt class="py-comment"># For modules, remove any submodules that match var_name_re.</tt> </tt>
<a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-319" class="py-name" targets="Class epydoc.apidoc.ModuleDoc=epydoc.apidoc.ModuleDoc-class.html"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-319', 'ModuleDoc', 'link-319');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"> <tt class="py-name">removed</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">m</tt> <tt class="py-keyword">for</tt> <tt class="py-name">m</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-320" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.submodules=epydoc.apidoc.ModuleDoc-class.html#submodules"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-320', 'submodules', 'link-320');">submodules</a></tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_name_re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt id="link-321" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-321', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">removed</tt><tt class="py-op">:</tt> </tt>
<a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"> <tt class="py-comment"># Remove the indicated submodules from this module.</tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-322" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-322', 'submodules', 'link-320');">submodules</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">m</tt> <tt class="py-keyword">for</tt> <tt class="py-name">m</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-323" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-323', 'submodules', 'link-320');">submodules</a></tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">m</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">removed</tt><tt class="py-op">]</tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"> <tt class="py-comment"># Remove all ancestors of the indicated submodules</tt> </tt>
<a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># from the docindex root. E.g., if module x</tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># declares y to be undocumented, then x.y.z should</tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># also be undocumented.</tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">elt</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">m</tt> <tt class="py-keyword">in</tt> <tt class="py-name">removed</tt><tt class="py-op">:</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt id="link-324" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-324', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">.</tt><tt id="link-325" class="py-name" targets="Method epydoc.apidoc.DottedName.dominates()=epydoc.apidoc.DottedName-class.html#dominates"><a title="epydoc.apidoc.DottedName.dominates" class="py-name" href="#" onclick="return doclink('link-325', 'dominates', 'link-325');">dominates</a></tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">.</tt><tt id="link-326" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-326', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">)</tt> </tt>
</div><a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> </tt>
<a name="process_group_field"></a><div id="process_group_field-def"><a name="L694"></a><tt class="py-lineno"> 694</tt> <a class="py-toggle" href="#" id="process_group_field-toggle" onclick="return toggle('process_group_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_group_field">process_group_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_group_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_group_field-expanded"><a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt class="py-docstring">"""Define a group named C{arg} containing the variables whose</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"><tt class="py-docstring"> names are listed in C{descr}."""</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"> <tt id="link-327" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-327', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-328" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-328', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-329" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-329', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-330" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-330', 'NamespaceDoc', 'link-54');">NamespaceDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-331" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-331', 'group_specs', 'link-187');">group_specs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt id="link-332" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-332', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-333" class="py-name"><a title="epydoc.docstringparser._descr_to_identifiers" class="py-name" href="#" onclick="return doclink('link-333', '_descr_to_identifiers', 'link-312');">_descr_to_identifiers</a></tt><tt class="py-op">(</tt><tt id="link-334" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-334', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
</div><a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-comment"># [xx] should this also set sort order?</tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_deffield_field"></a><div id="process_deffield_field-def"><a name="L701"></a><tt class="py-lineno"> 701</tt> <a class="py-toggle" href="#" id="process_deffield_field-toggle" onclick="return toggle('process_deffield_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_deffield_field">process_deffield_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_deffield_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_deffield_field-expanded"><a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-docstring">"""Define a new custom field."""</tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt id="link-335" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-335', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-336" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-336', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-337" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-337', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-338" class="py-name"><a title="epydoc.apidoc.APIDoc.extra_docstring_fields" class="py-name" href="#" onclick="return doclink('link-338', 'extra_docstring_fields', 'link-285');">extra_docstring_fields</a></tt> <tt class="py-keyword">is</tt> <tt id="link-339" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-339', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-340" class="py-name"><a title="epydoc.apidoc.APIDoc.extra_docstring_fields" class="py-name" href="#" onclick="return doclink('link-340', 'extra_docstring_fields', 'link-285');">extra_docstring_fields</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> <tt class="py-name">docstring_field</tt> <tt class="py-op">=</tt> <tt id="link-341" class="py-name" targets="Function epydoc.docstringparser._descr_to_docstring_field()=epydoc.docstringparser-module.html#_descr_to_docstring_field"><a title="epydoc.docstringparser._descr_to_docstring_field" class="py-name" href="#" onclick="return doclink('link-341', '_descr_to_docstring_field', 'link-341');">_descr_to_docstring_field</a></tt><tt class="py-op">(</tt><tt id="link-342" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-342', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-343" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-343', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> <tt class="py-name">docstring_field</tt><tt class="py-op">.</tt><tt class="py-name">varnames</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"__%s__"</tt> <tt class="py-op">%</tt> <tt id="link-344" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-344', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-345" class="py-name"><a title="epydoc.apidoc.APIDoc.extra_docstring_fields" class="py-name" href="#" onclick="return doclink('link-345', 'extra_docstring_fields', 'link-285');">extra_docstring_fields</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">docstring_field</tt><tt class="py-op">)</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad %s: %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-346" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-346', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> </tt>
<a name="process_raise_field"></a><div id="process_raise_field-def"><a name="L713"></a><tt class="py-lineno"> 713</tt> <a class="py-toggle" href="#" id="process_raise_field-toggle" onclick="return toggle('process_raise_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_raise_field">process_raise_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_raise_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_raise_field-expanded"><a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-docstring">"""Record the fact that C{api_doc} can raise the exception named</tt> </tt>
<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"><tt class="py-docstring"> C{tag} in C{api_doc.exception_descrs}."""</tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> <tt id="link-347" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-347', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-348" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-348', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-349" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-349', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-350" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-350', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-string">'single'</tt><tt class="py-op">)</tt> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-351" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-351', 'name', 'link-207');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-352" class="py-name" targets="Class epydoc.apidoc.DottedName=epydoc.apidoc.DottedName-class.html"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-352', 'DottedName', 'link-352');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-353" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-353', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">strict</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-354" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-354', 'DottedName', 'link-352');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-355" class="py-name" targets="Class epydoc.apidoc.DottedName.InvalidDottedName=epydoc.apidoc.DottedName.InvalidDottedName-class.html"><a title="epydoc.apidoc.DottedName.InvalidDottedName" class="py-name" href="#" onclick="return doclink('link-355', 'InvalidDottedName', 'link-355');">InvalidDottedName</a></tt><tt class="py-op">:</tt> <tt id="link-356" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-356', 'name', 'link-207');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-357" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-357', 'arg', 'link-85');">arg</a></tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-358" class="py-name"><a title="epydoc.apidoc.RoutineDoc.exception_descrs" class="py-name" href="#" onclick="return doclink('link-358', 'exception_descrs', 'link-178');">exception_descrs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt id="link-359" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-359', 'name', 'link-207');">name</a></tt><tt class="py-op">,</tt> <tt id="link-360" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-360', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
</div><a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> </tt>
<a name="process_sort_field"></a><div id="process_sort_field-def"><a name="L721"></a><tt class="py-lineno"> 721</tt> <a class="py-toggle" href="#" id="process_sort_field-toggle" onclick="return toggle('process_sort_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_sort_field">process_sort_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_sort_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_sort_field-expanded"><a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"> <tt id="link-361" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-361', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-362" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-362', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-363" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-363', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-364" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-364', 'NamespaceDoc', 'link-54');">NamespaceDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-365" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-365', 'sort_spec', 'link-153');">sort_spec</a></tt> <tt class="py-op">=</tt> <tt id="link-366" class="py-name"><a title="epydoc.docstringparser._descr_to_identifiers" class="py-name" href="#" onclick="return doclink('link-366', '_descr_to_identifiers', 'link-312');">_descr_to_identifiers</a></tt><tt class="py-op">(</tt><tt id="link-367" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-367', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-368" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-368', 'sort_spec', 'link-153');">sort_spec</a></tt> </tt>
</div><a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"><tt class="py-comment"># [xx] should I notice when they give a type for an unknown var?</tt> </tt>
<a name="process_type_field"></a><div id="process_type_field-def"><a name="L726"></a><tt class="py-lineno"> 726</tt> <a class="py-toggle" href="#" id="process_type_field-toggle" onclick="return toggle('process_type_field');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_type_field">process_type_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_type_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_type_field-expanded"><a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-comment"># In namespace, "@type var: ..." describes the type of a var.</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-369" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-369', 'NamespaceDoc', 'link-54');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt id="link-370" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-370', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-371" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-371', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-372" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-372', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-string">'single'</tt><tt class="py-op">)</tt> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> <tt id="link-373" class="py-name" targets="Function epydoc.docstringparser.set_var_type()=epydoc.docstringparser-module.html#set_var_type"><a title="epydoc.docstringparser.set_var_type" class="py-name" href="#" onclick="return doclink('link-373', 'set_var_type', 'link-373');">set_var_type</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-374" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-374', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-375" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-375', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> </tt>
<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"> <tt class="py-comment"># For variables & properties, "@type: ..." describes the variable.</tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt id="link-376" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-376', 'VariableDoc', 'link-181');">VariableDoc</a></tt><tt class="py-op">,</tt> <tt id="link-377" class="py-name"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-377', 'PropertyDoc', 'link-182');">PropertyDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"> <tt id="link-378" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-378', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-379" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-379', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-380" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-380', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-381" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-381', 'type_descr', 'link-183');">type_descr</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-382" class="py-name"><a title="epydoc.docstringparser.REDEFINED" class="py-name" href="#" onclick="return doclink('link-382', 'REDEFINED', 'link-264');">REDEFINED</a></tt> <tt class="py-op">%</tt> <tt id="link-383" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-383', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-384" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-384', 'type_descr', 'link-183');">type_descr</a></tt> <tt class="py-op">=</tt> <tt id="link-385" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-385', 'descr', 'link-70');">descr</a></tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"> <tt class="py-comment"># For routines, "@type param: ..." describes a parameter.</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-386" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-386', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> <tt id="link-387" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-387', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-388" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-388', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-389" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-389', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-string">'single'</tt><tt class="py-op">)</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-390" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-390', 'arg', 'link-85');">arg</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-391" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-391', 'arg_types', 'link-169');">arg_types</a></tt><tt class="py-op">:</tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-392" class="py-name"><a title="epydoc.docstringparser.REDEFINED" class="py-name" href="#" onclick="return doclink('link-392', 'REDEFINED', 'link-264');">REDEFINED</a></tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">'type for '</tt><tt class="py-op">+</tt><tt id="link-393" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-393', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-394" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-394', 'arg_types', 'link-169');">arg_types</a></tt><tt class="py-op">[</tt><tt id="link-395" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-395', 'arg', 'link-85');">arg</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-396" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-396', 'descr', 'link-70');">descr</a></tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-397" class="py-name"><a title="epydoc.docstringparser.BAD_CONTEXT" class="py-name" href="#" onclick="return doclink('link-397', 'BAD_CONTEXT', 'link-263');">BAD_CONTEXT</a></tt> <tt class="py-op">%</tt> <tt id="link-398" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-398', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"> </tt>
<a name="process_var_field"></a><div id="process_var_field-def"><a name="L749"></a><tt class="py-lineno"> 749</tt> <a class="py-toggle" href="#" id="process_var_field-toggle" onclick="return toggle('process_var_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_var_field">process_var_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_var_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_var_field-expanded"><a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"> <tt id="link-399" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-399', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-400" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-400', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-401" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-401', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-402" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-402', 'ModuleDoc', 'link-319');">ModuleDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'[:;, ] *'</tt><tt class="py-op">,</tt> <tt id="link-403" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-403', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"> <tt id="link-404" class="py-name" targets="Function epydoc.docstringparser.set_var_descr()=epydoc.docstringparser-module.html#set_var_descr"><a title="epydoc.docstringparser.set_var_descr" class="py-name" href="#" onclick="return doclink('link-404', 'set_var_descr', 'link-404');">set_var_descr</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">ident</tt><tt class="py-op">,</tt> <tt id="link-405" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-405', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> </tt>
<a name="process_cvar_field"></a><div id="process_cvar_field-def"><a name="L754"></a><tt class="py-lineno"> 754</tt> <a class="py-toggle" href="#" id="process_cvar_field-toggle" onclick="return toggle('process_cvar_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_cvar_field">process_cvar_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_cvar_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_cvar_field-expanded"><a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> <tt class="py-comment"># If @cvar is used *within* a variable, then use it as the</tt> </tt>
<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># variable's description, and treat the variable as a class var.</tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-406" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-406', 'VariableDoc', 'link-181');">VariableDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-407" class="py-name" targets="Method epydoc.apidoc.DocIndex.container()=epydoc.apidoc.DocIndex-class.html#container,Method epydoc.apidoc.DottedName.container()=epydoc.apidoc.DottedName-class.html#container,Variable epydoc.apidoc.VariableDoc.container=epydoc.apidoc.VariableDoc-class.html#container"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-407', 'container', 'link-407');">container</a></tt><tt class="py-op">,</tt> <tt id="link-408" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-408', 'ClassDoc', 'link-74');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> <tt id="link-409" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-409', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-410" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-410', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-411" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-411', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-412" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_instvar=epydoc.apidoc.VariableDoc-class.html#is_instvar"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-412', 'is_instvar', 'link-412');">is_instvar</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-413" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-413', 'descr', 'link-70');">descr</a></tt> <tt class="py-op">=</tt> <tt id="link-414" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-414', 'markup', 'link-1');">markup</a></tt><tt class="py-op">.</tt><tt id="link-415" class="py-name" targets="Class epydoc.markup.ConcatenatedDocstring=epydoc.markup.ConcatenatedDocstring-class.html"><a title="epydoc.markup.ConcatenatedDocstring" class="py-name" href="#" onclick="return doclink('link-415', 'ConcatenatedDocstring', 'link-415');">ConcatenatedDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-416" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-416', 'descr', 'link-70');">descr</a></tt><tt class="py-op">,</tt> <tt id="link-417" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-417', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-418" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-418', 'summary', 'link-96');">summary</a></tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-419" class="py-name"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-419', 'other_docs', 'link-99');">other_docs</a></tt> <tt class="py-op">=</tt> <tt id="link-420" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-420', 'descr', 'link-70');">descr</a></tt><tt class="py-op">.</tt><tt id="link-421" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-421', 'summary', 'link-96');">summary</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, @cvar should be used in a class.</tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt id="link-422" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-422', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-423" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-423', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-424" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-424', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-425" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-425', 'ClassDoc', 'link-74');">ClassDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'[:;, ] *'</tt><tt class="py-op">,</tt> <tt id="link-426" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-426', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> <tt id="link-427" class="py-name"><a title="epydoc.docstringparser.set_var_descr" class="py-name" href="#" onclick="return doclink('link-427', 'set_var_descr', 'link-404');">set_var_descr</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">ident</tt><tt class="py-op">,</tt> <tt id="link-428" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-428', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-429" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-429', 'variables', 'link-75');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">ident</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-430" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-430', 'is_instvar', 'link-412');">is_instvar</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"> </tt>
<a name="process_ivar_field"></a><div id="process_ivar_field-def"><a name="L771"></a><tt class="py-lineno"> 771</tt> <a class="py-toggle" href="#" id="process_ivar_field-toggle" onclick="return toggle('process_ivar_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_ivar_field">process_ivar_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_ivar_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_ivar_field-expanded"><a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> <tt class="py-comment"># If @ivar is used *within* a variable, then use it as the</tt> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># variable's description, and treat the variable as an instvar.</tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-431" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-431', 'VariableDoc', 'link-181');">VariableDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-432" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-432', 'container', 'link-407');">container</a></tt><tt class="py-op">,</tt> <tt id="link-433" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-433', 'ClassDoc', 'link-74');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"> <tt id="link-434" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-434', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-435" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-435', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-436" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-436', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"> <tt class="py-comment"># require that there be no other descr?</tt> </tt>
<a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-437" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-437', 'is_instvar', 'link-412');">is_instvar</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-438" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-438', 'descr', 'link-70');">descr</a></tt> <tt class="py-op">=</tt> <tt id="link-439" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-439', 'markup', 'link-1');">markup</a></tt><tt class="py-op">.</tt><tt id="link-440" class="py-name"><a title="epydoc.markup.ConcatenatedDocstring" class="py-name" href="#" onclick="return doclink('link-440', 'ConcatenatedDocstring', 'link-415');">ConcatenatedDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-441" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-441', 'descr', 'link-70');">descr</a></tt><tt class="py-op">,</tt> <tt id="link-442" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-442', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-443" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-443', 'summary', 'link-96');">summary</a></tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-444" class="py-name"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-444', 'other_docs', 'link-99');">other_docs</a></tt> <tt class="py-op">=</tt> <tt id="link-445" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-445', 'descr', 'link-70');">descr</a></tt><tt class="py-op">.</tt><tt id="link-446" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-446', 'summary', 'link-96');">summary</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, @ivar should be used in a class.</tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"> <tt id="link-447" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-447', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-448" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-448', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-449" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-449', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-450" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-450', 'ClassDoc', 'link-74');">ClassDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'[:;, ] *'</tt><tt class="py-op">,</tt> <tt id="link-451" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-451', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> <tt id="link-452" class="py-name"><a title="epydoc.docstringparser.set_var_descr" class="py-name" href="#" onclick="return doclink('link-452', 'set_var_descr', 'link-404');">set_var_descr</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">ident</tt><tt class="py-op">,</tt> <tt id="link-453" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-453', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-454" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-454', 'variables', 'link-75');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">ident</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-455" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-455', 'is_instvar', 'link-412');">is_instvar</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"><tt class="py-comment"># [xx] '@return: foo' used to get used as a descr if no other</tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># descr was present. is that still true?</tt> </tt>
<a name="process_return_field"></a><div id="process_return_field-def"><a name="L791"></a><tt class="py-lineno"> 791</tt> <a class="py-toggle" href="#" id="process_return_field-toggle" onclick="return toggle('process_return_field');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_return_field">process_return_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_return_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_return_field-expanded"><a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> <tt id="link-456" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-456', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-457" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-457', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-458" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-458', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-459" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-459', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-460" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-460', 'return_descr', 'link-104');">return_descr</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-461" class="py-name"><a title="epydoc.docstringparser.REDEFINED" class="py-name" href="#" onclick="return doclink('link-461', 'REDEFINED', 'link-264');">REDEFINED</a></tt> <tt class="py-op">%</tt> <tt class="py-string">'return value description'</tt><tt class="py-op">)</tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-462" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-462', 'return_descr', 'link-104');">return_descr</a></tt> <tt class="py-op">=</tt> <tt id="link-463" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-463', 'descr', 'link-70');">descr</a></tt> </tt>
</div><a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> </tt>
<a name="process_rtype_field"></a><div id="process_rtype_field-def"><a name="L797"></a><tt class="py-lineno"> 797</tt> <a class="py-toggle" href="#" id="process_rtype_field-toggle" onclick="return toggle('process_rtype_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_rtype_field">process_rtype_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_rtype_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_rtype_field-expanded"><a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> <tt id="link-464" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-464', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-465" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-465', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-466" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-466', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-op">(</tt><tt id="link-467" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-467', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">,</tt> <tt id="link-468" class="py-name"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-468', 'PropertyDoc', 'link-182');">PropertyDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-469" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-469', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-470" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-470', 'return_type', 'link-175');">return_type</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-471" class="py-name"><a title="epydoc.docstringparser.REDEFINED" class="py-name" href="#" onclick="return doclink('link-471', 'REDEFINED', 'link-264');">REDEFINED</a></tt> <tt class="py-op">%</tt> <tt class="py-string">'return value type'</tt><tt class="py-op">)</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-472" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-472', 'return_type', 'link-175');">return_type</a></tt> <tt class="py-op">=</tt> <tt id="link-473" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-473', 'descr', 'link-70');">descr</a></tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-474" class="py-name"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-474', 'PropertyDoc', 'link-182');">PropertyDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"> <tt id="link-475" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-475', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-476" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-476', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-477" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-477', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-478" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-478', 'type_descr', 'link-183');">type_descr</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-479" class="py-name"><a title="epydoc.docstringparser.REDEFINED" class="py-name" href="#" onclick="return doclink('link-479', 'REDEFINED', 'link-264');">REDEFINED</a></tt> <tt class="py-op">%</tt> <tt id="link-480" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-480', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-481" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-481', 'type_descr', 'link-183');">type_descr</a></tt> <tt class="py-op">=</tt> <tt id="link-482" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-482', 'descr', 'link-70');">descr</a></tt> </tt>
</div><a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> </tt>
<a name="process_arg_field"></a><div id="process_arg_field-def"><a name="L811"></a><tt class="py-lineno"> 811</tt> <a class="py-toggle" href="#" id="process_arg_field-toggle" onclick="return toggle('process_arg_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_arg_field">process_arg_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_arg_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_arg_field-expanded"><a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"> <tt id="link-483" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-483', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-484" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-484', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-485" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-485', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-486" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-486', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"> <tt class="py-name">idents</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'[:;, ] *'</tt><tt class="py-op">,</tt> <tt id="link-487" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-487', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-488" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-488', 'arg_descrs', 'link-166');">arg_descrs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">idents</tt><tt class="py-op">,</tt> <tt id="link-489" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-489', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"> <tt class="py-comment"># Check to make sure that the documented parameter(s) are</tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># actually part of the function signature.</tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-490" class="py-name" targets="Method epydoc.apidoc.RoutineDoc.all_args()=epydoc.apidoc.RoutineDoc-class.html#all_args"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-490', 'all_args', 'link-490');">all_args</a></tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-491" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-491', 'all_args', 'link-490');">all_args</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-492" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-492', 'all_args', 'link-490');">all_args</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'...'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-493" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-493', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"> <tt class="py-name">bad_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'"%s"'</tt> <tt class="py-op">%</tt> <tt class="py-name">i</tt> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">idents</tt> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-494" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-494', 'all_args', 'link-490');">all_args</a></tt><tt class="py-op">]</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">bad_params</tt><tt class="py-op">:</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-495" class="py-name"><a title="epydoc.docstringparser.BAD_PARAM" class="py-name" href="#" onclick="return doclink('link-495', 'BAD_PARAM', 'link-266');">BAD_PARAM</a></tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-496" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-496', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">bad_params</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"> </tt>
<a name="process_kwarg_field"></a><div id="process_kwarg_field-def"><a name="L823"></a><tt class="py-lineno"> 823</tt> <a class="py-toggle" href="#" id="process_kwarg_field-toggle" onclick="return toggle('process_kwarg_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#process_kwarg_field">process_kwarg_field</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_kwarg_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_kwarg_field-expanded"><a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> <tt class="py-comment"># [xx] these should -not- be checked if they exist..</tt> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and listed separately or not??</tt> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-497" class="py-name"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-497', '_check', 'link-277');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-498" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-498', 'tag', 'link-84');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-499" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-499', 'arg', 'link-85');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt id="link-500" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-500', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> <tt class="py-name">idents</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'[:;, ] *'</tt><tt class="py-op">,</tt> <tt id="link-501" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-501', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-502" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-502', 'arg_descrs', 'link-166');">arg_descrs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">idents</tt><tt class="py-op">,</tt> <tt id="link-503" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-503', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
</div><a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"> </tt>
<a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"><tt id="link-504" class="py-name" targets="Function epydoc.docstringparser.register_field_handler()=epydoc.docstringparser-module.html#register_field_handler"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-504', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-505" class="py-name" targets="Function epydoc.docstringparser.process_group_field()=epydoc.docstringparser-module.html#process_group_field"><a title="epydoc.docstringparser.process_group_field" class="py-name" href="#" onclick="return doclink('link-505', 'process_group_field', 'link-505');">process_group_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'group'</tt><tt class="py-op">)</tt> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"><tt id="link-506" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-506', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-507" class="py-name" targets="Function epydoc.docstringparser.process_deffield_field()=epydoc.docstringparser-module.html#process_deffield_field"><a title="epydoc.docstringparser.process_deffield_field" class="py-name" href="#" onclick="return doclink('link-507', 'process_deffield_field', 'link-507');">process_deffield_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'deffield'</tt><tt class="py-op">,</tt> <tt class="py-string">'newfield'</tt><tt class="py-op">)</tt> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"><tt id="link-508" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-508', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-509" class="py-name" targets="Function epydoc.docstringparser.process_sort_field()=epydoc.docstringparser-module.html#process_sort_field"><a title="epydoc.docstringparser.process_sort_field" class="py-name" href="#" onclick="return doclink('link-509', 'process_sort_field', 'link-509');">process_sort_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'sort'</tt><tt class="py-op">)</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"><tt id="link-510" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-510', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-511" class="py-name" targets="Function epydoc.docstringparser.process_summary_field()=epydoc.docstringparser-module.html#process_summary_field"><a title="epydoc.docstringparser.process_summary_field" class="py-name" href="#" onclick="return doclink('link-511', 'process_summary_field', 'link-511');">process_summary_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'summary'</tt><tt class="py-op">)</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"><tt id="link-512" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-512', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-513" class="py-name" targets="Function epydoc.docstringparser.process_undocumented_field()=epydoc.docstringparser-module.html#process_undocumented_field"><a title="epydoc.docstringparser.process_undocumented_field" class="py-name" href="#" onclick="return doclink('link-513', 'process_undocumented_field', 'link-513');">process_undocumented_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'undocumented'</tt><tt class="py-op">)</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"><tt id="link-514" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-514', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-515" class="py-name" targets="Function epydoc.docstringparser.process_include_field()=epydoc.docstringparser-module.html#process_include_field"><a title="epydoc.docstringparser.process_include_field" class="py-name" href="#" onclick="return doclink('link-515', 'process_include_field', 'link-515');">process_include_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'include'</tt><tt class="py-op">)</tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"><tt id="link-516" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-516', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-517" class="py-name" targets="Function epydoc.docstringparser.process_var_field()=epydoc.docstringparser-module.html#process_var_field"><a title="epydoc.docstringparser.process_var_field" class="py-name" href="#" onclick="return doclink('link-517', 'process_var_field', 'link-517');">process_var_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'var'</tt><tt class="py-op">,</tt> <tt class="py-string">'variable'</tt><tt class="py-op">)</tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"><tt id="link-518" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-518', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-519" class="py-name" targets="Function epydoc.docstringparser.process_type_field()=epydoc.docstringparser-module.html#process_type_field"><a title="epydoc.docstringparser.process_type_field" class="py-name" href="#" onclick="return doclink('link-519', 'process_type_field', 'link-519');">process_type_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'type'</tt><tt class="py-op">)</tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"><tt id="link-520" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-520', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-521" class="py-name" targets="Function epydoc.docstringparser.process_cvar_field()=epydoc.docstringparser-module.html#process_cvar_field"><a title="epydoc.docstringparser.process_cvar_field" class="py-name" href="#" onclick="return doclink('link-521', 'process_cvar_field', 'link-521');">process_cvar_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'cvar'</tt><tt class="py-op">,</tt> <tt class="py-string">'cvariable'</tt><tt class="py-op">)</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"><tt id="link-522" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-522', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-523" class="py-name" targets="Function epydoc.docstringparser.process_ivar_field()=epydoc.docstringparser-module.html#process_ivar_field"><a title="epydoc.docstringparser.process_ivar_field" class="py-name" href="#" onclick="return doclink('link-523', 'process_ivar_field', 'link-523');">process_ivar_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'ivar'</tt><tt class="py-op">,</tt> <tt class="py-string">'ivariable'</tt><tt class="py-op">)</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"><tt id="link-524" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-524', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-525" class="py-name" targets="Function epydoc.docstringparser.process_return_field()=epydoc.docstringparser-module.html#process_return_field"><a title="epydoc.docstringparser.process_return_field" class="py-name" href="#" onclick="return doclink('link-525', 'process_return_field', 'link-525');">process_return_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'return'</tt><tt class="py-op">,</tt> <tt class="py-string">'returns'</tt><tt class="py-op">)</tt> </tt>
<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"><tt id="link-526" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-526', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-527" class="py-name" targets="Function epydoc.docstringparser.process_rtype_field()=epydoc.docstringparser-module.html#process_rtype_field"><a title="epydoc.docstringparser.process_rtype_field" class="py-name" href="#" onclick="return doclink('link-527', 'process_rtype_field', 'link-527');">process_rtype_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'rtype'</tt><tt class="py-op">,</tt> <tt class="py-string">'returntype'</tt><tt class="py-op">)</tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"><tt id="link-528" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-528', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-529" class="py-name" targets="Function epydoc.docstringparser.process_arg_field()=epydoc.docstringparser-module.html#process_arg_field"><a title="epydoc.docstringparser.process_arg_field" class="py-name" href="#" onclick="return doclink('link-529', 'process_arg_field', 'link-529');">process_arg_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'arg'</tt><tt class="py-op">,</tt> <tt class="py-string">'argument'</tt><tt class="py-op">,</tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-string">'parameter'</tt><tt class="py-op">,</tt> <tt class="py-string">'param'</tt><tt class="py-op">)</tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"><tt id="link-530" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-530', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-531" class="py-name" targets="Function epydoc.docstringparser.process_kwarg_field()=epydoc.docstringparser-module.html#process_kwarg_field"><a title="epydoc.docstringparser.process_kwarg_field" class="py-name" href="#" onclick="return doclink('link-531', 'process_kwarg_field', 'link-531');">process_kwarg_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'kwarg'</tt><tt class="py-op">,</tt> <tt class="py-string">'keyword'</tt><tt class="py-op">,</tt> <tt class="py-string">'kwparam'</tt><tt class="py-op">)</tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"><tt id="link-532" class="py-name"><a title="epydoc.docstringparser.register_field_handler" class="py-name" href="#" onclick="return doclink('link-532', 'register_field_handler', 'link-504');">register_field_handler</a></tt><tt class="py-op">(</tt><tt id="link-533" class="py-name" targets="Function epydoc.docstringparser.process_raise_field()=epydoc.docstringparser-module.html#process_raise_field"><a title="epydoc.docstringparser.process_raise_field" class="py-name" href="#" onclick="return doclink('link-533', 'process_raise_field', 'link-533');">process_raise_field</a></tt><tt class="py-op">,</tt> <tt class="py-string">'raise'</tt><tt class="py-op">,</tt> <tt class="py-string">'raises'</tt><tt class="py-op">,</tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"> <tt class="py-string">'except'</tt><tt class="py-op">,</tt> <tt class="py-string">'exception'</tt><tt class="py-op">)</tt> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"><tt class="py-comment"># Tags related to function parameters</tt> </tt>
<a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-534" class="py-name"><a title="epydoc.docstringparser.PARAMETER_TAGS" class="py-name" href="#" onclick="return doclink('link-534', 'PARAMETER_TAGS', 'link-202');">PARAMETER_TAGS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'arg'</tt><tt class="py-op">,</tt> <tt class="py-string">'argument'</tt><tt class="py-op">,</tt> <tt class="py-string">'parameter'</tt><tt class="py-op">,</tt> <tt class="py-string">'param'</tt><tt class="py-op">,</tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"> <tt class="py-string">'kwarg'</tt><tt class="py-op">,</tt> <tt class="py-string">'keyword'</tt><tt class="py-op">,</tt> <tt class="py-string">'kwparam'</tt><tt class="py-op">)</tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"> </tt>
<a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"><tt class="py-comment"># Tags related to variables in a class</tt> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-535" class="py-name"><a title="epydoc.docstringparser.VARIABLE_TAGS" class="py-name" href="#" onclick="return doclink('link-535', 'VARIABLE_TAGS', 'link-199');">VARIABLE_TAGS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'cvar'</tt><tt class="py-op">,</tt> <tt class="py-string">'cvariable'</tt><tt class="py-op">,</tt> <tt class="py-string">'ivar'</tt><tt class="py-op">,</tt> <tt class="py-string">'ivariable'</tt><tt class="py-op">)</tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"><tt class="py-comment"># Tags related to exceptions</tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-536" class="py-name"><a title="epydoc.docstringparser.EXCEPTION_TAGS" class="py-name" href="#" onclick="return doclink('link-536', 'EXCEPTION_TAGS', 'link-206');">EXCEPTION_TAGS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'raise'</tt><tt class="py-op">,</tt> <tt class="py-string">'raises'</tt><tt class="py-op">,</tt> <tt class="py-string">'except'</tt><tt class="py-op">,</tt> <tt class="py-string">'exception'</tt><tt class="py-op">)</tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Helper Functions</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="check_type_fields"></a><div id="check_type_fields-def"><a name="L862"></a><tt class="py-lineno"> 862</tt> <a class="py-toggle" href="#" id="check_type_fields-toggle" onclick="return toggle('check_type_fields');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#check_type_fields">check_type_fields</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">field_warnings</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="check_type_fields-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="check_type_fields-expanded"><a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"> <tt class="py-docstring">"""Check to make sure that all type fields correspond to some</tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"><tt class="py-docstring"> documented parameter; if not, append a warning to field_warnings."""</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-537" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-537', 'RoutineDoc', 'link-46');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-538" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-538', 'arg', 'link-85');">arg</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-539" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-539', 'arg_types', 'link-169');">arg_types</a></tt><tt class="py-op">:</tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-540" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-540', 'arg', 'link-85');">arg</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-541" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-541', 'all_args', 'link-490');">all_args</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">args</tt><tt class="py-op">,</tt> <tt id="link-542" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-542', 'descr', 'link-70');">descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-543" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-543', 'arg_descrs', 'link-166');">arg_descrs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-544" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-544', 'arg', 'link-85');">arg</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> </tt>
<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt class="py-name">field_warnings</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-545" class="py-name"><a title="epydoc.docstringparser.BAD_PARAM" class="py-name" href="#" onclick="return doclink('link-545', 'BAD_PARAM', 'link-266');">BAD_PARAM</a></tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">,</tt> <tt class="py-string">'"%s"'</tt> <tt class="py-op">%</tt> <tt id="link-546" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-546', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> </tt>
<a name="set_var_descr"></a><div id="set_var_descr-def"><a name="L874"></a><tt class="py-lineno"> 874</tt> <a class="py-toggle" href="#" id="set_var_descr-toggle" onclick="return toggle('set_var_descr');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#set_var_descr">set_var_descr</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">ident</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_var_descr-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_var_descr-expanded"><a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-547" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-547', 'variables', 'link-75');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-548" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-548', 'variables', 'link-75');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">ident</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-549" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-549', 'VariableDoc', 'link-181');">VariableDoc</a></tt><tt class="py-op">(</tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"> <tt id="link-550" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-550', 'container', 'link-407');">container</a></tt><tt class="py-op">=</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-551" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-551', 'name', 'link-207');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">ident</tt><tt class="py-op">,</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"> <tt id="link-552" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-552', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">=</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-553" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-553', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">+</tt><tt class="py-name">ident</tt><tt class="py-op">)</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-554" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-554', 'variables', 'link-75');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">ident</tt><tt class="py-op">]</tt> </tt>
<a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-555" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-555', 'descr', 'link-70');">descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-556" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-556', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-557" class="py-name"><a title="epydoc.docstringparser.REDEFINED" class="py-name" href="#" onclick="return doclink('link-557', 'REDEFINED', 'link-264');">REDEFINED</a></tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">'description for '</tt><tt class="py-op">+</tt><tt class="py-name">ident</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-558" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-558', 'descr', 'link-70');">descr</a></tt> <tt class="py-op">=</tt> <tt id="link-559" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-559', 'descr', 'link-70');">descr</a></tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-560" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-560', 'summary', 'link-96');">summary</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-561" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-561', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-562" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-562', 'summary', 'link-96');">summary</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-563" class="py-name"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-563', 'other_docs', 'link-99');">other_docs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-564" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-564', 'descr', 'link-70');">descr</a></tt><tt class="py-op">.</tt><tt id="link-565" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-565', 'summary', 'link-96');">summary</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> </tt>
<a name="set_var_type"></a><div id="set_var_type-def"><a name="L887"></a><tt class="py-lineno"> 887</tt> <a class="py-toggle" href="#" id="set_var_type-toggle" onclick="return toggle('set_var_type');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#set_var_type">set_var_type</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">ident</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_var_type-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_var_type-expanded"><a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-566" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-566', 'variables', 'link-75');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-567" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-567', 'variables', 'link-75');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">ident</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-568" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-568', 'VariableDoc', 'link-181');">VariableDoc</a></tt><tt class="py-op">(</tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt id="link-569" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-569', 'container', 'link-407');">container</a></tt><tt class="py-op">=</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-570" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-570', 'name', 'link-207');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">ident</tt><tt class="py-op">,</tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> <tt id="link-571" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-571', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">=</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-572" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-572', 'canonical_name', 'link-47');">canonical_name</a></tt><tt class="py-op">+</tt><tt class="py-name">ident</tt><tt class="py-op">)</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-573" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-573', 'variables', 'link-75');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">ident</tt><tt class="py-op">]</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-574" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-574', 'type_descr', 'link-183');">type_descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-575" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-575', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-576" class="py-name"><a title="epydoc.docstringparser.REDEFINED" class="py-name" href="#" onclick="return doclink('link-576', 'REDEFINED', 'link-264');">REDEFINED</a></tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">'type for '</tt><tt class="py-op">+</tt><tt class="py-name">ident</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-577" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-577', 'type_descr', 'link-183');">type_descr</a></tt> <tt class="py-op">=</tt> <tt id="link-578" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-578', 'descr', 'link-70');">descr</a></tt> </tt>
</div><a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"> </tt>
<a name="_check"></a><div id="_check-def"><a name="L898"></a><tt class="py-lineno"> 898</tt> <a class="py-toggle" href="#" id="_check-toggle" onclick="return toggle('_check');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#_check">_check</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">expect_arg</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_check-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_check-expanded"><a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">context</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-579" class="py-name"><a title="epydoc.docstringparser.BAD_CONTEXT" class="py-name" href="#" onclick="return doclink('link-579', 'BAD_CONTEXT', 'link-263');">BAD_CONTEXT</a></tt> <tt class="py-op">%</tt> <tt id="link-580" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-580', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">expect_arg</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">expect_arg</tt> <tt class="py-op">==</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-581" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-581', 'arg', 'link-85');">arg</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-582" class="py-name"><a title="epydoc.docstringparser.EXPECTED_ARG" class="py-name" href="#" onclick="return doclink('link-582', 'EXPECTED_ARG', 'link-261');">EXPECTED_ARG</a></tt> <tt class="py-op">%</tt> <tt id="link-583" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-583', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
<a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">expect_arg</tt> <tt class="py-op">==</tt> <tt class="py-name">False</tt><tt class="py-op">:</tt> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-584" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-584', 'arg', 'link-85');">arg</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-585" class="py-name"><a title="epydoc.docstringparser.UNEXPECTED_ARG" class="py-name" href="#" onclick="return doclink('link-585', 'UNEXPECTED_ARG', 'link-260');">UNEXPECTED_ARG</a></tt> <tt class="py-op">%</tt> <tt id="link-586" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-586', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">expect_arg</tt> <tt class="py-op">==</tt> <tt class="py-string">'single'</tt><tt class="py-op">:</tt> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt id="link-587" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-587', 'arg', 'link-85');">arg</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-string">' '</tt> <tt class="py-keyword">in</tt> <tt id="link-588" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-588', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt id="link-589" class="py-name"><a title="epydoc.docstringparser.EXPECTED_SINGLE_ARG" class="py-name" href="#" onclick="return doclink('link-589', 'EXPECTED_SINGLE_ARG', 'link-262');">EXPECTED_SINGLE_ARG</a></tt> <tt class="py-op">%</tt> <tt id="link-590" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-590', 'tag', 'link-84');">tag</a></tt><tt class="py-op">)</tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-string">'bad value for expect_arg'</tt> </tt>
</div><a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> </tt>
<a name="get_docformat"></a><div id="get_docformat-def"><a name="L915"></a><tt class="py-lineno"> 915</tt> <a class="py-toggle" href="#" id="get_docformat-toggle" onclick="return toggle('get_docformat');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#get_docformat">get_docformat</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_docformat-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_docformat-expanded"><a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"><tt class="py-docstring"> Return the name of the markup language that should be used to</tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"><tt class="py-docstring"> parse the API documentation for the given object.</tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"> <tt class="py-comment"># Find the module that defines api_doc.</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-591" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-591', 'defining_module', 'link-209');">defining_module</a></tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"> <tt class="py-comment"># Look up its docformat.</tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">module</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-592" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-592', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-593" class="py-name"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-593', 'docformat', 'link-61');">docformat</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-594" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-594', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"> <tt id="link-595" class="py-name"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-595', 'docformat', 'link-61');">docformat</a></tt> <tt class="py-op">=</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-596" class="py-name"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-596', 'docformat', 'link-61');">docformat</a></tt> </tt>
<a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"> <tt id="link-597" class="py-name"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-597', 'docformat', 'link-61');">docformat</a></tt> <tt class="py-op">=</tt> <tt id="link-598" class="py-name"><a title="epydoc.cli.DEFAULT_DOCFORMAT
epydoc.docstringparser.DEFAULT_DOCFORMAT" class="py-name" href="#" onclick="return doclink('link-598', 'DEFAULT_DOCFORMAT', 'link-43');">DEFAULT_DOCFORMAT</a></tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"> <tt class="py-comment"># Convert to lower case & strip region codes.</tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-599" class="py-name"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-599', 'docformat', 'link-61');">docformat</a></tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-600" class="py-name"><a title="epydoc.cli.DEFAULT_DOCFORMAT
epydoc.docstringparser.DEFAULT_DOCFORMAT" class="py-name" href="#" onclick="return doclink('link-600', 'DEFAULT_DOCFORMAT', 'link-43');">DEFAULT_DOCFORMAT</a></tt> </tt>
</div><a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"> </tt>
<a name="unindent_docstring"></a><div id="unindent_docstring-def"><a name="L931"></a><tt class="py-lineno"> 931</tt> <a class="py-toggle" href="#" id="unindent_docstring-toggle" onclick="return toggle('unindent_docstring');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#unindent_docstring">unindent_docstring</a><tt class="py-op">(</tt><tt class="py-param">docstring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="unindent_docstring-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="unindent_docstring-expanded"><a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> <tt class="py-comment"># [xx] copied from inspect.getdoc(); we can't use inspect.getdoc()</tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># itself, since it expects an object, not a string.</tt> </tt>
<a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-601" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-601', 'docstring', 'link-52');">docstring</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt id="link-602" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-602', 'docstring', 'link-52');">docstring</a></tt><tt class="py-op">.</tt><tt class="py-name">expandtabs</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-comment"># Find minimum indentation of any non-blank lines after first line.</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">margin</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">maxint</tt> </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">lstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">content</tt><tt class="py-op">:</tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"> <tt class="py-name">indent</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> <tt class="py-op">-</tt> <tt class="py-name">content</tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"> <tt class="py-name">margin</tt> <tt class="py-op">=</tt> <tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">margin</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"> <tt class="py-comment"># Remove indentation.</tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">lines</tt><tt class="py-op">:</tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">lstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">margin</tt> <tt class="py-op"><</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">maxint</tt><tt class="py-op">:</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-name">margin</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"> <tt class="py-comment"># Remove any trailing (but not leading!) blank lines.</tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">while</tt> <tt class="py-name">lines</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"> <tt class="py-name">lines</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> <tt class="py-comment">#while lines and not lines[0]:</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># lines.pop(0)</tt> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt> </tt>
</div><a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"> </tt>
<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"><tt id="link-603" class="py-name" targets="Variable epydoc.docstringparser._IDENTIFIER_LIST_REGEXP=epydoc.docstringparser-module.html#_IDENTIFIER_LIST_REGEXP"><a title="epydoc.docstringparser._IDENTIFIER_LIST_REGEXP" class="py-name" href="#" onclick="return doclink('link-603', '_IDENTIFIER_LIST_REGEXP', 'link-603');">_IDENTIFIER_LIST_REGEXP</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'^[\w.\*]+([\s,:;]\s*[\w.\*]+)*$'</tt><tt class="py-op">)</tt> </tt>
<a name="_descr_to_identifiers"></a><div id="_descr_to_identifiers-def"><a name="L958"></a><tt class="py-lineno"> 958</tt> <a class="py-toggle" href="#" id="_descr_to_identifiers-toggle" onclick="return toggle('_descr_to_identifiers');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#_descr_to_identifiers">_descr_to_identifiers</a><tt class="py-op">(</tt><tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_descr_to_identifiers-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_descr_to_identifiers-expanded"><a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"><tt class="py-docstring"> Given a C{ParsedDocstring} that contains a list of identifiers,</tt> </tt>
<a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"><tt class="py-docstring"> return a list of those identifiers. This is used by fields such</tt> </tt>
<a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"><tt class="py-docstring"> as C{@group} and C{@sort}, which expect lists of identifiers as</tt> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"><tt class="py-docstring"> their values. To extract the identifiers, the docstring is first</tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-docstring"> converted to plaintext, and then split. The plaintext content of</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"><tt class="py-docstring"> the docstring must be a a list of identifiers, separated by</tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"><tt class="py-docstring"> spaces, commas, colons, or semicolons.</tt> </tt>
<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{list} of C{string}</tt> </tt>
<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"><tt class="py-docstring"> @return: A list of the identifier names contained in C{descr}.</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"><tt class="py-docstring"> @type descr: L{markup.ParsedDocstring}</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-docstring"> @param descr: A C{ParsedDocstring} containing a list of</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-docstring"> identifiers.</tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"><tt class="py-docstring"> @raise ValueError: If C{descr} does not contain a valid list of</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"><tt class="py-docstring"> identifiers.</tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"> <tt class="py-name">idents</tt> <tt class="py-op">=</tt> <tt id="link-604" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-604', 'descr', 'link-70');">descr</a></tt><tt class="py-op">.</tt><tt id="link-605" class="py-name" targets="Method epydoc.markup.ConcatenatedDocstring.to_plaintext()=epydoc.markup.ConcatenatedDocstring-class.html#to_plaintext,Method epydoc.markup.ParsedDocstring.to_plaintext()=epydoc.markup.ParsedDocstring-class.html#to_plaintext,Method epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext,Function epydoc.markup.epytext.to_plaintext()=epydoc.markup.epytext-module.html#to_plaintext,Method epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#to_plaintext,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_plaintext,Method epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_plaintext"><a title="epydoc.markup.ConcatenatedDocstring.to_plaintext
epydoc.markup.ParsedDocstring.to_plaintext
epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext
epydoc.markup.epytext.to_plaintext
epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext
epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext" class="py-name" href="#" onclick="return doclink('link-605', 'to_plaintext', 'link-605');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"> <tt class="py-name">idents</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">r'\s+'</tt><tt class="py-op">,</tt> <tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt class="py-name">idents</tt><tt class="py-op">)</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-606" class="py-name"><a title="epydoc.docstringparser._IDENTIFIER_LIST_REGEXP" class="py-name" href="#" onclick="return doclink('link-606', '_IDENTIFIER_LIST_REGEXP', 'link-603');">_IDENTIFIER_LIST_REGEXP</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">idents</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-string">'Bad Identifier list: %r'</tt> <tt class="py-op">%</tt> <tt class="py-name">idents</tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt class="py-name">rval</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'[:;, ] *'</tt><tt class="py-op">,</tt> <tt class="py-name">idents</tt><tt class="py-op">)</tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">rval</tt> </tt>
</div><a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> </tt>
<a name="_descr_to_docstring_field"></a><div id="_descr_to_docstring_field-def"><a name="L983"></a><tt class="py-lineno"> 983</tt> <a class="py-toggle" href="#" id="_descr_to_docstring_field-toggle" onclick="return toggle('_descr_to_docstring_field');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#_descr_to_docstring_field">_descr_to_docstring_field</a><tt class="py-op">(</tt><tt class="py-param">arg</tt><tt class="py-op">,</tt> <tt class="py-param">descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_descr_to_docstring_field-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_descr_to_docstring_field-expanded"><a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-name">tags</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">s</tt> <tt class="py-keyword">in</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'[:;, ] *'</tt><tt class="py-op">,</tt> <tt id="link-607" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-607', 'arg', 'link-85');">arg</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> <tt id="link-608" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-608', 'descr', 'link-70');">descr</a></tt> <tt class="py-op">=</tt> <tt id="link-609" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-609', 'descr', 'link-70');">descr</a></tt><tt class="py-op">.</tt><tt id="link-610" class="py-name"><a title="epydoc.markup.ConcatenatedDocstring.to_plaintext
epydoc.markup.ParsedDocstring.to_plaintext
epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext
epydoc.markup.epytext.to_plaintext
epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext
epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext" class="py-name" href="#" onclick="return doclink('link-610', 'to_plaintext', 'link-605');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'[:;,] *'</tt><tt class="py-op">,</tt> <tt id="link-611" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-611', 'descr', 'link-70');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">3</tt><tt class="py-op">:</tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-string">'Wrong number of arguments'</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> <tt class="py-name">singular</tt> <tt class="py-op">=</tt> <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> <tt class="py-op">>=</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> <tt class="py-name">plural</tt> <tt class="py-op">=</tt> <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">plural</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> <tt class="py-name">short</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> <tt class="py-op">>=</tt> <tt class="py-number">3</tt><tt class="py-op">:</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'short'</tt><tt class="py-op">:</tt> <tt class="py-name">short</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad arg 2 (expected "short")'</tt><tt class="py-op">)</tt> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-612" class="py-name"><a title="epydoc.docstringparser.DocstringField" class="py-name" href="#" onclick="return doclink('link-612', 'DocstringField', 'link-19');">DocstringField</a></tt><tt class="py-op">(</tt><tt class="py-name">tags</tt><tt class="py-op">,</tt> <tt class="py-name">singular</tt><tt class="py-op">,</tt> <tt class="py-name">plural</tt><tt class="py-op">,</tt> <tt class="py-name">short</tt><tt class="py-op">)</tt> </tt>
</div><a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Function Signature Extraction</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"><tt class="py-comment"># [XX] todo: add optional type modifiers?</tt> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-613" class="py-name" targets="Variable epydoc.docstringparser._SIGNATURE_RE=epydoc.docstringparser-module.html#_SIGNATURE_RE"><a title="epydoc.docstringparser._SIGNATURE_RE" class="py-name" href="#" onclick="return doclink('link-613', '_SIGNATURE_RE', 'link-613');">_SIGNATURE_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"> <tt class="py-comment"># Class name (for builtin methods)</tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> <tt class="py-string">r'^\s*((?P<self>\w+)\.)?'</tt> <tt class="py-op">+</tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-comment"># The function name (must match exactly) [XX] not anymore!</tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"> <tt class="py-string">r'(?P<func>\w+)'</tt> <tt class="py-op">+</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-comment"># The parameters</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> <tt class="py-string">r'\((?P<params>(\s*\[?\s*\*{0,2}[\w\-\.]+(\s*=.+?)?'</tt><tt class="py-op">+</tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> <tt class="py-string">r'(\s*\[?\s*,\s*\]?\s*\*{0,2}[\w\-\.]+(\s*=.+?)?)*\]*)?)\s*\)'</tt> <tt class="py-op">+</tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"> <tt class="py-comment"># The return value (optional)</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"> <tt class="py-string">r'(\s*(->)\s*(?P<return>\S.*?))?'</tt><tt class="py-op">+</tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> <tt class="py-comment"># The end marker</tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> <tt class="py-string">r'\s*(\n|\s+(--|<=+>)\s+|$|\.\s+|\.\n)'</tt><tt class="py-op">)</tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"><tt class="py-string">"""A regular expression that is used to extract signatures from</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"><tt class="py-string">docstrings."""</tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> </tt>
<a name="parse_function_signature"></a><div id="parse_function_signature-def"><a name="L1018"></a><tt class="py-lineno">1018</tt> <a class="py-toggle" href="#" id="parse_function_signature-toggle" onclick="return toggle('parse_function_signature');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docstringparser-module.html#parse_function_signature">parse_function_signature</a><tt class="py-op">(</tt><tt class="py-param">func_doc</tt><tt class="py-op">,</tt> <tt class="py-param">doc_source</tt><tt class="py-op">,</tt> <tt class="py-param">docformat</tt><tt class="py-op">,</tt> <tt class="py-param">parse_errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_function_signature-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_function_signature-expanded"><a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"><tt class="py-docstring"> Construct the signature for a builtin function or method from</tt> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"><tt class="py-docstring"> its docstring. If the docstring uses the standard convention</tt> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"><tt class="py-docstring"> of including a signature in the first line of the docstring</tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"><tt class="py-docstring"> (and formats that signature according to standard</tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"><tt class="py-docstring"> conventions), then it will be used to extract a signature.</tt> </tt>
<a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"><tt class="py-docstring"> Otherwise, the signature will be set to a single varargs</tt> </tt>
<a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"><tt class="py-docstring"> variable named C{"..."}.</tt> </tt>
<a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"><tt class="py-docstring"> @param func_doc: The target object where to store parsed signature. Also</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"><tt class="py-docstring"> container of the docstring to parse if doc_source is C{None}</tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"><tt class="py-docstring"> @type func_doc: L{RoutineDoc}</tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"><tt class="py-docstring"> @param doc_source: Contains the docstring to parse. If C{None}, parse</tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"><tt class="py-docstring"> L{func_doc} docstring instead</tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"><tt class="py-docstring"> @type doc_source: L{APIDoc}</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc_source</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"> <tt class="py-name">doc_source</tt> <tt class="py-op">=</tt> <tt class="py-name">func_doc</tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"> <tt class="py-comment"># If there's no docstring, then don't do anything.</tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">doc_source</tt><tt class="py-op">.</tt><tt id="link-614" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-614', 'docstring', 'link-52');">docstring</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"> <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt id="link-615" class="py-name"><a title="epydoc.docstringparser._SIGNATURE_RE" class="py-name" href="#" onclick="return doclink('link-615', '_SIGNATURE_RE', 'link-613');">_SIGNATURE_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">doc_source</tt><tt class="py-op">.</tt><tt id="link-616" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-616', 'docstring', 'link-52');">docstring</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">m</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"> <tt class="py-comment"># Do I want to be this strict?</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Notice that __init__ must match the class name instead, if the signature</tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># comes from the class docstring</tt> </tt>
<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># if not (m.group('func') == func_doc.canonical_name[-1] or</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># '_'+m.group('func') == func_doc.canonical_name[-1]):</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># log.warning("Not extracting function signature from %s's "</tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># "docstring, since the name doesn't match." %</tt> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># func_doc.canonical_name)</tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># return False</tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'params'</tt><tt class="py-op">)</tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"> <tt class="py-name">rtype</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'return'</tt><tt class="py-op">)</tt> </tt>
<a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"> <tt class="py-name">selfparam</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'self'</tt><tt class="py-op">)</tt> </tt>
<a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"> <tt class="py-comment"># Extract the parameters from the signature.</tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-617" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posargs=epydoc.apidoc.RoutineDoc-class.html#posargs"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-617', 'posargs', 'link-617');">posargs</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-618" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.vararg=epydoc.apidoc.RoutineDoc-class.html#vararg"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-618', 'vararg', 'link-618');">vararg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-619" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.kwarg=epydoc.apidoc.RoutineDoc-class.html#kwarg"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-619', 'kwarg', 'link-619');">kwarg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-620" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posarg_defaults=epydoc.apidoc.RoutineDoc-class.html#posarg_defaults"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-620', 'posarg_defaults', 'link-620');">posarg_defaults</a></tt> <tt class="py-keyword">is</tt> <tt id="link-621" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-621', 'UNKNOWN', 'link-45');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-622" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-622', 'posarg_defaults', 'link-620');">posarg_defaults</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">params</tt><tt class="py-op">:</tt> </tt>
<a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"> <tt class="py-comment"># Figure out which parameters are optional.</tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">while</tt> <tt class="py-string">'['</tt> <tt class="py-keyword">in</tt> <tt class="py-name">params</tt> <tt class="py-keyword">or</tt> <tt class="py-string">']'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">params</tt><tt class="py-op">:</tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"> <tt class="py-name">m2</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">r'(.*)\[([^\[\]]+)\](.*)'</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">m2</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">start</tt><tt class="py-op">,</tt> <tt class="py-name">mid</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">m2</tt><tt class="py-op">.</tt><tt class="py-name">groups</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"> <tt class="py-name">mid</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">r'((,|^)\s*[\w\-\.]+)'</tt><tt class="py-op">,</tt> <tt class="py-string">r'\1=...'</tt><tt class="py-op">,</tt> <tt class="py-name">mid</tt><tt class="py-op">)</tt> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-name">start</tt><tt class="py-op">+</tt><tt class="py-name">mid</tt><tt class="py-op">+</tt><tt class="py-name">end</tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">r'=...='</tt> <tt class="py-op">,</tt> <tt class="py-string">r'='</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-623" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-623', 'name', 'link-207');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">','</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'='</tt> <tt class="py-keyword">in</tt> <tt id="link-624" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-624', 'name', 'link-207');">name</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-625" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-625', 'name', 'link-207');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">default_repr</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt id="link-626" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-626', 'name', 'link-207');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'='</tt><tt class="py-op">,</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"> <tt class="py-name">default</tt> <tt class="py-op">=</tt> <tt id="link-627" class="py-name" targets="Class epydoc.apidoc.GenericValueDoc=epydoc.apidoc.GenericValueDoc-class.html"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-627', 'GenericValueDoc', 'link-627');">GenericValueDoc</a></tt><tt class="py-op">(</tt><tt id="link-628" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.parse_repr=epydoc.apidoc.ValueDoc-class.html#parse_repr"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-628', 'parse_repr', 'link-628');">parse_repr</a></tt><tt class="py-op">=</tt><tt class="py-name">default_repr</tt><tt class="py-op">)</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"> <tt class="py-name">default</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"> <tt id="link-629" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-629', 'name', 'link-207');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-630" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-630', 'name', 'link-207');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-631" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-631', 'name', 'link-207');">name</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'...'</tt><tt class="py-op">:</tt> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-632" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-632', 'vararg', 'link-618');">vararg</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'...'</tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-633" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-633', 'name', 'link-207');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'**'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-634" class="py-name"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-634', 'kwarg', 'link-619');">kwarg</a></tt> <tt class="py-op">=</tt> <tt id="link-635" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-635', 'name', 'link-207');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-636" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-636', 'name', 'link-207');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'*'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-637" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-637', 'vararg', 'link-618');">vararg</a></tt> <tt class="py-op">=</tt> <tt id="link-638" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-638', 'name', 'link-207');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-639" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-639', 'posargs', 'link-617');">posargs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-640" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-640', 'name', 'link-207');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-641" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-641', 'posarg_defaults', 'link-620');">posarg_defaults</a></tt><tt class="py-op">)</tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-642" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-642', 'posargs', 'link-617');">posargs</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-643" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-643', 'posarg_defaults', 'link-620');">posarg_defaults</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">default</tt><tt class="py-op">)</tt> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">default</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> <tt class="py-name">argnum</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-644" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-644', 'posargs', 'link-617');">posargs</a></tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-number">1</tt> </tt>
<a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-645" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-645', 'posarg_defaults', 'link-620');">posarg_defaults</a></tt><tt class="py-op">[</tt><tt class="py-name">argnum</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">default</tt> </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"> <tt class="py-comment"># Extract the return type/value from the signature</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">rtype</tt><tt class="py-op">:</tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-646" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-646', 'return_type', 'link-175');">return_type</a></tt> <tt class="py-op">=</tt> <tt id="link-647" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-647', 'markup', 'link-1');">markup</a></tt><tt class="py-op">.</tt><tt id="link-648" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-648', 'parse', 'link-67');">parse</a></tt><tt class="py-op">(</tt><tt class="py-name">rtype</tt><tt class="py-op">,</tt> <tt id="link-649" class="py-name"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-649', 'docformat', 'link-61');">docformat</a></tt><tt class="py-op">,</tt> <tt class="py-name">parse_errors</tt><tt class="py-op">,</tt> </tt>
<a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"> <tt class="py-name">inline</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"> <tt class="py-comment"># Add the self parameter, if it was specified.</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">selfparam</tt><tt class="py-op">:</tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-650" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-650', 'posargs', 'link-617');">posargs</a></tt><tt class="py-op">.</tt><tt class="py-name">insert</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">selfparam</tt><tt class="py-op">)</tt> </tt>
<a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-651" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-651', 'posarg_defaults', 'link-620');">posarg_defaults</a></tt><tt class="py-op">.</tt><tt class="py-name">insert</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"> </tt>
<a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> <tt class="py-comment"># Remove the signature from the docstring.</tt> </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">doc_source</tt><tt class="py-op">.</tt><tt id="link-652" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-652', 'docstring', 'link-52');">docstring</a></tt> <tt class="py-op">=</tt> <tt class="py-name">doc_source</tt><tt class="py-op">.</tt><tt id="link-653" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-653', 'docstring', 'link-52');">docstring</a></tt><tt class="py-op">[</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">end</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> </tt>
<a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"> <tt class="py-comment"># We found a signature.</tt> </tt>
<a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:09:55 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
