← Back to branch summary

~ubuntu-branches/debian/lenny/epydoc/lenny

« back to all changes in this revision

Viewing changes to doc/api/public/epydoc.markup.plaintext-module.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2008-02-03 13:22:12 UTC
  • mfrom: (1.2.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080203132212-u2uohl6rswmlz2ra
Tags: 3.0.1-1
* New upstream release.
* Removed #! from top of epydoc/gui.py
* Got rid of version mangling in debian/watch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/public/epydoc.markup.plaintext-module.html
1
 
<?xml version="1.0" encoding="iso-8859-1"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
 
          "DTD/xhtml1-transitional.dtd">
4
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<head>
6
 
  <title>epydoc.markup.plaintext</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8
 
</head>
9
 
<body bgcolor="white" text="black" link="blue" vlink="#204080"
10
 
      alink="#204080">
11
 
 
12
 
<!-- =========== START OF NAVBAR =========== -->
13
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14
 
  <tr valign="center">
15
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
16
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
17
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
18
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
19
 
    <th class="navbar" align="right" width="100%">
20
 
      <table border="0" cellpadding="0" cellspacing="0">
21
 
      <tr><th class="navbar" align="center">
22
 
        <p class="nomargin">
23
 
          <a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
24
 
      </p></th></tr></table>
25
 
    </th>
26
 
  </tr>
27
 
</table>
28
 
<table width="100%" cellpadding="0" cellspacing="0">
29
 
  <tr valign="top">
30
 
    <td width="100%">
31
 
      <font size="-1"><b class="breadcrumbs">
32
 
        <a href="epydoc-module.html">Package&nbsp;epydoc</a> ::
33
 
        <a href="epydoc.markup-module.html">Package&nbsp;markup</a> ::
34
 
        Module&nbsp;plaintext
35
 
      </b></font></br>
36
 
    </td>
37
 
    <td><table cellpadding="0" cellspacing="0">
38
 
      <tr><td align="right"><font size="-2">[<a href="../private/epydoc.markup.plaintext-module.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
39
 
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="epydoc.markup.plaintext-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
40
 
    </table></td>
41
 
</tr></table>
42
 
 
43
 
<!-- =========== START OF MODULE DESCRIPTION =========== -->
44
 
<h2 class="module">Module epydoc.markup.plaintext</h2>
45
 
 
46
 
<pre class="literalblock">
47
 
Parser for plaintext docstrings.  Plaintext docstrings are rendered as
48
 
verbatim output, preserving all whitespace.
49
 
</pre>
50
 
<hr/>
51
 
 
52
 
<!-- =========== START OF CLASSES =========== -->
53
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
54
 
<tr bgcolor="#70b0f0" class="summary">
55
 
  <th colspan="2">Classes</th></tr>
56
 
<tr><td width="15%">
57
 
  <b><a href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html"><code>ParsedPlaintextDocstring</code></a></b></td>
58
 
  <td>&nbsp;</td></tr>
59
 
</table><br />
60
 
 
61
 
 
62
 
<!-- =========== START OF FUNCTION SUMMARY =========== -->
63
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
64
 
<tr bgcolor="#70b0f0" class="summary">
65
 
  <th colspan="2">Function Summary</th></tr>
66
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
67
 
  <td><code><span class="summary-sig"><a href="epydoc.markup.plaintext-module.html#parse_docstring" class="summary-sig-name"><code>parse_docstring</code></a>(<span class=summary-sig-arg>docstring</span>,
68
 
          <span class=summary-sig-arg>errors</span>,
69
 
          <span class="summary-sig-kwarg">**options</span>)</span></code>
70
 
<br />
71
 
&#64;return: A pair C{(M{d}, M{e})}, where C{M{d}} is a
72
 
    C{ParsedDocstring} that encodes the contents of the given
73
 
    plaintext docstring; and C{M{e}} is a list of errors that were
74
 
    generated while parsing the docstring.</td></tr>
75
 
</table><br />
76
 
 
77
 
 
78
 
<!-- =========== START OF FUNCTION DETAILS =========== -->
79
 
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
80
 
<tr bgcolor="#70b0f0" class="details">
81
 
  <th colspan="2">Function Details</th></tr>
82
 
</table>
83
 
 
84
 
<a name="parse_docstring"></a>
85
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
86
 
  <h3><span class="sig"><span class="sig-name">parse_docstring</span>(<span class=sig-arg>docstring</span>,
87
 
          <span class=sig-arg>errors</span>,
88
 
          <span class="sig-kwarg">**options</span>)</span>
89
 
  </h3>
90
 
<pre class="literalblock">
91
 
&#64;return: A pair C{(M{d}, M{e})}, where C{M{d}} is a
92
 
    C{ParsedDocstring} that encodes the contents of the given
93
 
    plaintext docstring; and C{M{e}} is a list of errors that were
94
 
    generated while parsing the docstring.
95
 
&#64;rtype: C{L{ParsedPlaintextDocstring}, C{list} of L{ParseError}}
96
 
</pre>
97
 
  <dl><dt></dt><dd>
98
 
  </dd></dl>
99
 
</td></tr></table>
100
 
<br />
101
 
 
102
 
 
103
 
<!-- =========== START OF NAVBAR =========== -->
104
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
105
 
  <tr valign="center">
106
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
107
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
108
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
109
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
110
 
    <th class="navbar" align="right" width="100%">
111
 
      <table border="0" cellpadding="0" cellspacing="0">
112
 
      <tr><th class="navbar" align="center">
113
 
        <p class="nomargin">
114
 
          <a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
115
 
      </p></th></tr></table>
116
 
    </th>
117
 
  </tr>
118
 
</table>
119
 
 
120
 
<table border="0" cellpadding="0" cellspacing="0" width="100%">
121
 
  <tr>
122
 
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:19 2004</font></td>
123
 
    <td align="right"><a href="http://epydoc.sourceforge.net"
124
 
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
125
 
  </tr>
126
 
</table>
127
 
</body>
128
 
</html>