Revision: 2433
Author: pekka.klarck
Date: Fri Feb 5 14:51:42 2010
Log: regen
http://code.google.com/p/robotframework/source/detail?r=2433
Modified:
/trunk/tools/libdoc/doc/libdoc.html
=======================================
--- /trunk/tools/libdoc/doc/libdoc.html Tue Oct 20 04:28:40 2009
+++ /trunk/tools/libdoc/doc/libdoc.html Fri Feb 5 14:51:42 2010
@@ -313,6 +313,8 @@
text-align: left;
padding-bottom: 0.5em;
font-style: italic;
+ font-size: 0.9em;
+ width: 100%;
}
table.example th, table.example td, table.tsv-example td {
border: 1px solid #808080;
@@ -331,7 +333,7 @@
border: 1px solid black;
padding: 0.1em 0.3em;
height: 1.2em;
- font-size: 0.9em;
+ font-size: 0.8em;
}
table.messages {
border: 1px solid gray;
@@ -391,7 +393,7 @@
/* Overridden and modified styles */
cite {
- font-size: 0.9em;
+ font-size: 0.95em;
}
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
@@ -521,10 +523,14 @@
<li><a class="reference internal" href="#dynamic-libraries"
id="id13">Dynamic libraries</a></li>
<li><a class="reference internal" href="#importing-section"
id="id14">Importing section</a></li>
<li><a class="reference internal" href="#resource-files"
id="id15">Resource files</a></li>
-<li><a class="reference internal" href="#documentation-formatting"
id="id16">Documentation formatting</a></li>
-<li><a class="reference internal" href="#keyword-arguments"
id="id17">Keyword arguments</a></li>
</ul>
</li>
+<li><a class="reference internal" href="#documentation-syntax"
id="id16">Documentation syntax</a><ul>
+<li><a class="reference internal" href="#generic-formatting-rules"
id="id17">Generic formatting rules</a></li>
+<li><a class="reference internal"
href="#special-formatting-and-internal-linking" id="id18">Special
formatting and internal linking</a></li>
+<li><a class="reference internal" href="#keywords-arguments"
id="id19">Keywords' arguments</a></li>
+</ul>
+</li>
</ul>
</div>
<div class="section" id="synopsis">
@@ -675,7 +681,6 @@
realistic examples. For more information on Python documentation
strings, see <a class="reference external"
href="http://www.python.org/dev/peps/pep-0257";>PEP-257</a>.</p>
<div class="highlight"><pre><span class="k">class</span> <span
class="nc">ExampleLib</span><span class="p">:</span>
-
<span class="sd">"""Library for demo purposes.</span>
<span class="sd"> This library is only used in an example and it
does't do anything useful.</span>
@@ -733,7 +738,7 @@
they must return keyword argument names and documentation using
<span class="code">get_keyword_arguments</span> and <span
class="code">get_keyword_documentation</span>
methods (or using their camelCase variants <span
class="code">getKeywordArguments</span>
-and <span class="code">getKeywordDocumentation</span>). See the <a
class="reference external"
href="http://code.google.com/p/robotframework/wiki/UserGuide";>user
guide</a> for more
+and <span class="code">getKeywordDocumentation</span>). See the <a
class="reference external"
href="http://code.google.com/p/robotframework/wiki/UserGuide";>User
Guide</a> for more
information about how to create these methods and the dynamic library
API in general.</p>
</div>
@@ -844,10 +849,14 @@
</tbody>
</table>
</div>
-<div class="section" id="documentation-formatting">
-<h2><a class="toc-backref" href="#id16">Documentation formatting</a></h2>
-<p>The <a class="reference external"
href="http://code.google.com/p/robotframework/wiki/UserGuide";>user
guide</a> has an appendix explaining different documentation
-formatting possibilities. Most important features are formatting using
+</div>
+<div class="section" id="documentation-syntax">
+<h1><a class="toc-backref" href="#id16">Documentation syntax</a></h1>
+<div class="section" id="generic-formatting-rules">
+<h2><a class="toc-backref" href="#id17">Generic formatting rules</a></h2>
+<p>The <a class="reference external"
href="http://code.google.com/p/robotframework/wiki/UserGuide";>User
Guide</a> has an appendix explaining different documentation
+formatting possibilities supported by Robot Framework.
+Most important features are formatting using
<span class="code">*bold*</span> and <span class="code">_italic_</span>,
automatic conversion of URLs to
clickable links, and the possibility to create tables (useful for
examples) simply with pipe character:</p>
@@ -855,7 +864,10 @@
| Some Keyword | arg |
| Another Keyword | |
</pre>
-<p>In addition to the formatting explained in the user guide,
+</div>
+<div class="section" id="special-formatting-and-internal-linking">
+<h2><a class="toc-backref" href="#id18">Special formatting and internal
linking</a></h2>
+<p>In addition to the formatting explained in the User Guide,
<span class="prog">libdoc.py</span> supports also special formatting of
keyword names
and arguments with backtick character <span class="code">`</span>. Even
more
importantly, this syntax also automatically creates internal links to
@@ -888,12 +900,12 @@
libraries</a>, so their documentation (and source) acts as a more
realistic example.</p>
</div>
-<div class="section" id="keyword-arguments">
-<h2><a class="toc-backref" href="#id17">Keyword arguments</a></h2>
-<p><span class="prog">libdoc.py</span> handles keyword arguments
automatically so that
+<div class="section" id="keywords-arguments">
+<h2><a class="toc-backref" href="#id19">Keywords' arguments</a></h2>
+<p><span class="prog">libdoc.py</span> handles keywords' arguments
automatically so that
arguments specified for methods in libraries or user keywords in
resource files are listed in a separate column. Possible trailing
-spaces in argument names are stripped to make it possible to use
+underscores in argument names are stripped to make it possible to use
arguments like <span class="code">list_</span> in the code and still have
<span class="code">list</span>
in documentation. Additionally, user keyword arguments are shown
without <span class="var">${}</span> or <span class="var">@{}</span>
to make arguments look the same
@@ -903,7 +915,7 @@
</div>
<div class="footer">
<hr class="footer" />
-Generated on: 2009-10-20 11:25 UTC.
+Generated on: 2010-02-05 22:51 UTC.
</div>
</body>
