[Epydoc-commits] SF.net SVN: epydoc: [1586] trunk/epydoc/src/epydoc/docwriter/xlink.py

[<dva...@us...>]

Revision: 1586
          http://svn.sourceforge.net/epydoc/?rev=1586&view=rev
Author:   dvarrazzo
Date:     2007-03-13 18:53:42 -0700 (Tue, 13 Mar 2007)

Log Message:
-----------
- Some docstring fixed.

Modified Paths:
--------------
    trunk/epydoc/src/epydoc/docwriter/xlink.py

Modified: trunk/epydoc/src/epydoc/docwriter/xlink.py
===================================================================
--- trunk/epydoc/src/epydoc/docwriter/xlink.py	2007-03-14 01:53:14 UTC (rev 1585)
+++ trunk/epydoc/src/epydoc/docwriter/xlink.py	2007-03-14 01:53:42 UTC (rev 1586)
@@ -298,12 +298,14 @@
 api_register = {}
 """
 Mapping from the API name to the `UrlGenerator` to be used.
+
+Use `register_api()` to add new generators to the register.
 """
 
 def register_api(name, generator=None):
     """Register the API `name` into the `api_register`.
 
-    A registered API is available to the markup as the interpreted text
+    A registered API will be available to the markup as the interpreted text
     role ``name``.
 
     If a `generator` is not provided, register a `VoidUrlGenerator` instance:
@@ -366,8 +368,16 @@
     """
     Create and register a new role to create links for an API documentation.
 
-    Create a role called `name`, which will use the ``name`` registered
-    URL resolver to create a link for an object.
+    Create a role called `name`, which will use the URL resolver registered as
+    ``name`` in `api_register` to create a link for an object.
+
+    :Parameters:
+      `name` : `str`
+        name of the role to create.
+      `problematic` : `bool`
+        if True, the registered role will create problematic nodes in
+        case of failed references. If False, a warning will be raised
+        anyway, but the output will appear as an ordinary literal.
     """
     def resolve_api_name(n, rawtext, text, lineno, inliner,
                 options={}, content=[]):


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.