<?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.markup.ConcatenatedDocstring</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> :: <a href="epydoc.markup-module.html">Package markup</a> :: Class ConcatenatedDocstring </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.markup.ConcatenatedDocstring-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class ConcatenatedDocstring</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring">source code</a></span></p> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Instance Methods</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceMethods" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">*parsed_docstrings</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.__init__">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___30-summary-div');return false;">call graph</a></span> </td> </tr> </table> <div style="display:none" id="call_graph_for___init___30-summary-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for___init___30" name="call_graph_for___init___30"> <area shape="rect" href="epydoc.docstringparser-module.html#process_cvar_field" title="docstringparser.process_cvar_field()" alt="" coords="7,6,300,38" /> <area shape="rect" href="epydoc.markup.ConcatenatedDocstring-class.html#__init__" title="__init__()" alt="" coords="351,62,447,94" /> <area shape="rect" href="epydoc.docstringparser-module.html#process_ivar_field" title="docstringparser.process_ivar_field()" alt="" coords="8,62,299,94" /> <area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#concatenate" title="ParsedDocstring.concatenate()" alt="" coords="28,118,279,150" /> </map> <img src="call_graph_for___init___30.gif" alt='' usemap="#call_graph_for___init___30" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="split_fields"></a><span class="summary-sig-name">split_fields</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">errors</span>=<span class="summary-sig-default">None</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.split_fields">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="summary"></a><span class="summary-sig-name">summary</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.summary">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="to_html"></a><span class="summary-sig-name">to_html</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">docstring_linker</span>, <span class="summary-sig-arg">**options</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.to_html">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_html_2-summary-div');return false;">call graph</a></span> </td> </tr> </table> <div style="display:none" id="call_graph_for_to_html_2-summary-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for_to_html_2" name="call_graph_for_to_html_2"> <area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html" title="docwriter.html.HTMLWriter.docstring_to_html()" alt="" coords="7,34,396,66" /> <area shape="rect" href="epydoc.markup.ConcatenatedDocstring-class.html#to_html" title="to_html()" alt="" coords="447,34,537,66" /> <area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html" title="epytext.ParsedEpytextDocstring.to_html()" alt="" coords="603,6,939,38" /> <area shape="rect" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_html" title="restructuredtext.ParsedRstDocstring.to_html()" alt="" coords="588,62,953,94" /> </map> <img src="call_graph_for_to_html_2.gif" alt='' usemap="#call_graph_for_to_html_2" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="to_latex"></a><span class="summary-sig-name">to_latex</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">docstring_linker</span>, <span class="summary-sig-arg">**options</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.to_latex">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="to_plaintext"></a><span class="summary-sig-name">to_plaintext</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">docstring_linker</span>, <span class="summary-sig-arg">**options</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.to_plaintext">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_to_plaintext_2-summary-div');return false;">call graph</a></span> </td> </tr> </table> <div style="display:none" id="call_graph_for_to_plaintext_2-summary-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for_to_plaintext_2" name="call_graph_for_to_plaintext_2"> <area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#_summary" title="docwriter.dotgraph.DotGraphUmlClassNode._summary()" alt="" coords="7,6,458,38" /> <area shape="rect" href="epydoc.markup.ConcatenatedDocstring-class.html#to_plaintext" title="to_plaintext()" alt="" coords="507,6,630,38" /> <area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext" title="epytext.ParsedEpytextDocstring.to_plaintext()" alt="" coords="678,6,1046,38" /> </map> <img src="call_graph_for_to_plaintext_2.gif" alt='' usemap="#call_graph_for_to_plaintext_2" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="index_terms"></a><span class="summary-sig-name">index_terms</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#ConcatenatedDocstring.index_terms">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_index_terms-summary-div');return false;">call graph</a></span> </td> </tr> </table> <div style="display:none" id="call_graph_for_index_terms-summary-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for_index_terms" name="call_graph_for_index_terms"> <area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_terms_from_docstring" title="docwriter.html.HTMLWriter._terms_from_docstring()" alt="" coords="6,6,435,38" /> <area shape="rect" href="epydoc.markup.ConcatenatedDocstring-class.html#index_terms" title="index_terms()" alt="" coords="483,6,611,38" /> <area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#index_terms" title="epytext.ParsedEpytextDocstring.index_terms()" alt="" coords="659,6,1030,38" /> </map> <img src="call_graph_for_index_terms.gif" alt='' usemap="#call_graph_for_index_terms" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> </td> </tr> </table> <!-- ==================== 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:08:23 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>