Changeset 166:d9c10a5b5c0d for wokkel/component.py

Timestamp:

Jan 23, 2012, 3:48:48 PM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Documentation fixes for pydoctor.

File:

• wokkel/component.py (modified) (4 diffs)

wokkel/component.py

@@ -76 +76 @@
 
     @ivar domains: Domains (as C{str}) this component will handle traffic for.
-    @type domains: L{set}
+    @type domains: C{set}
     """
 
@@ -251 +251 @@
 
     @ivar routes: Routes based on the host part of JIDs. Maps host names to the
-                  L{EventDispatcher<utility.EventDispatcher>}s that should
-                  receive the traffic. A key of C{None} means the default
-                  route.
+        L{EventDispatcher<twisted.words.xish.utility.EventDispatcher>}s that
+        should receive the traffic. A key of C{None} means the default route.
     @type routes: C{dict}
     """
@@ -271 +270 @@
         @param destination: Destination of the route to be added as a host name
                             or C{None} for the default route.
-        @type destination: C{str} or C{NoneType}.
+        @type destination: C{str} or C{NoneType}
+
         @param xs: XML Stream to register the route for.
-        @type xs: L{EventDispatcher<utility.EventDispatcher>}.
+        @type xs:
+            L{EventDispatcher<twisted.words.xish.utility.EventDispatcher>}
         """
         self.routes[destination] = xs
@@ -285 +286 @@
         @param destination: Destination of the route that should be removed.
         @type destination: C{str}.
+
         @param xs: XML Stream to remove the route for.
-        @type xs: L{EventDispatcher<utility.EventDispatcher>}.
+        @type xs:
+            L{EventDispatcher<twisted.words.xish.utility.EventDispatcher>}
         """
         xs.removeObserver('/*', self.route)