Author: laukpe
Date: Sun Nov 23 12:40:13 2008
New Revision: 1065
Modified:
trunk/tools/libdoc/doc/libdoc.txt
trunk/tools/libdoc/libdoc.py
Log:
changed term 'initialization' -> 'importing' based on latest comments to
issue 149
Modified: trunk/tools/libdoc/doc/libdoc.txt
==============================================================================
--- trunk/tools/libdoc/doc/libdoc.txt (original)
+++ trunk/tools/libdoc/doc/libdoc.txt Sun Nov 23 12:40:13 2008
@@ -181,11 +181,11 @@
API in general.
-Initialization section
-~~~~~~~~~~~~~~~~~~~~~~
+Importing section
+~~~~~~~~~~~~~~~~~
-An initialization section is created based on the initialization methods
-of the test library. For a Python library, if it has an :code:`__init__`
method
+A separate section about how the library is imported is created based on
its
+initialization methods. For a Python library, if it has
an :code:`__init__` method
that takes arguments in addition to :code:`self`, the documentation of that
method is shown. For a Java library, if it has a constructor that accepts
arguments, all its constructors and their javadocs are shown.
@@ -258,8 +258,8 @@
Additionally, using :code:`\`introduction\`` or :code:`\`library
introduction\``
(case insensitive) generates a link to the library introduction in the
beginneing
-of the generated documentation. Similarly :code:`\`initialization\``
-or :code:`\`library initialization\`` generates a link to the
`initialization section`_.
+of the generated documentation. Similarly :code:`\`importing\``
+or :code:`\`library importing\`` generates a link to the `importing
section`_.
Internal linking between keywords is used by all `standard
libraries`_, so their documentation (and source) acts as a more
Modified: trunk/tools/libdoc/libdoc.py
==============================================================================
--- trunk/tools/libdoc/libdoc.py (original)
+++ trunk/tools/libdoc/libdoc.py Sun Nov 23 12:40:13 2008
@@ -138,6 +138,8 @@
if ext in ['.html', '.htm', '.xhtml', '.tsv']:
return ResourceDoc(libname)
if ext == '.java':
+ if not utils.is_jython:
+ exit(error='Documenting Java test libraries requires Jython.')
return JavaLibraryDoc(libname)
return PythonLibraryDoc(libname)
@@ -182,8 +184,8 @@
return '<a href="#%s" class="name">%s</a>' % (kw.name,
name)
if utils.eq_any(name, ['introduction', 'library introduction']):
return '<a href="#introduction" class="name">%s</a>' % name
- if utils.eq_any(name, ['initialization', 'library
initialization']):
- return '<a href="#initialization" class="name">%s</a>' % name
+ if utils.eq_any(name, ['importing', 'library importing']):
+ return '<a href="#importing" class="name">%s</a>' % name
return '<span class="name">%s</span>' % name
@@ -448,7 +450,7 @@
<p class='libdoc'>${LIB.htmldoc}</p>
<!-- IF '${LIB.type}' != 'resource' -->
-<h2 id="initialization">Initialization</h2>
+<h2 id="importing">Importing</h2>
<!-- END IF -->
<!-- IF ${LIB.inits} -->
<table class="keywords">
