<?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.docwriter.plaintext.PlaintextWriter</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.docwriter-module.html">Package docwriter</a> ::
<a href="epydoc.docwriter.plaintext-module.html">Module plaintext</a> ::
Class PlaintextWriter
</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.docwriter.plaintext.PlaintextWriter-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PlaintextWriter</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter">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="write"></a><span class="summary-sig-name">write</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">**options</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.write">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="write_module"></a><span class="summary-sig-name">write_module</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">mod_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.write_module">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="baselist"></a><span class="summary-sig-name">baselist</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">class_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.baselist">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="write_class"></a><span class="summary-sig-name">write_class</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">class_doc</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.write_class">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="write_variable"></a><span class="summary-sig-name">write_variable</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">var_doc</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.write_variable">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="write_property"></a><span class="summary-sig-name">write_property</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">prop_doc</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.write_property">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="write_function"></a><span class="summary-sig-name">write_function</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">func_doc</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.write_function">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="write_signature"></a><span class="summary-sig-name">write_signature</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">func_doc</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">prefix</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.write_signature">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="fmt_arg"></a><span class="summary-sig-name">fmt_arg</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">default</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.fmt_arg">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="write_list"></a><span class="summary-sig-name">write_list</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">heading</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">value_type</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">imported</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">inherited</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">noindent</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.write_list">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<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="_descr"></a><span class="summary-sig-name">_descr</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">descr</span>,
<span class="summary-sig-arg">prefix</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter._descr">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="bold"></a><span class="summary-sig-name">bold</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">text</span>)</span><br />
Write a string in bold by overstriking.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.bold">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="title"></a><span class="summary-sig-name">title</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">text</span>,
<span class="summary-sig-arg">indent</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.title">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="section"></a><span class="summary-sig-name">section</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">text</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.plaintext-pysrc.html#PlaintextWriter.section">source code</a></span>
</td>
</tr>
</table>
</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:16 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>
