Changeset 166:d9c10a5b5c0d for wokkel/muc.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/muc.py (modified) (47 diffs)

wokkel/muc.py

@@ -228 +228 @@
 
     @param alternate: Optional room JID of an alternate venue.
-    @type alternate: L{jid.JID}
+    @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
     @param password: Optional password for entering the alternate venue.
@@ -398 +398 @@
 
     @ivar entity: The real JID of the entity this presence is from.
-    @type entity: L{jid.JID}
+    @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
     @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.
@@ -500 +500 @@
         Called when the XML stream has been initialized.
 
-        It initializes several XPath events to handle MUC stanzas that come in.
-        After those are initialized the method L{initialized} is called to
-        signal that we have finished.
+        It initializes several XPath events to handle MUC stanzas that come
+        in.
         """
         xmppim.BasePresenceProtocol.connectionInitialized(self)
@@ -547 +546 @@
         @param timeout: The number of seconds to wait before the deferred is
             timed out.
-        @type timeout: L{int}
+        @type timeout: C{int}
 
         The deferred object L{defer.Deferred} is returned.
@@ -590 +589 @@
 
         @param roomJID: The JID of the room the entity is joining.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nick: The nick name for the entitity joining the room.
@@ -623 +622 @@
 
         @param roomJID: The JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nick: The new nick name within the room.
@@ -640 +639 @@
 
         @param roomJID: The Room JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param show: The availability of the entity. Common values are xa,
@@ -662 +661 @@
 
         @param roomJID: The JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         occupantJID = self._roomOccupantMap[roomJID]
@@ -686 +685 @@
 
         @param occupantJID: The Room JID of the other user.
-        @type occupantJID: L{jid.JID}
+        @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         message = PrivateChat(recipient=occupantJID, body=body)
@@ -699 +698 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param subject: The subject you want to set.
@@ -715 +714 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param invitee: The entity that is being invited.
-        @type invitee: L{jid.JID}
+        @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param reason: The reason for the invite.
@@ -734 +733 @@
         @param room: The room jabber/xmpp entity id for the requested
             registration form.
-        @type room: L{jid.JID}
+        @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         def cb(response):
@@ -751 +750 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param options: A mapping of field names to values, or C{None} to
@@ -768 +767 @@
 
         @param roomJID: The room jabber/xmpp entity id.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         message = VoiceRequest(recipient=roomJID)
@@ -781 +780 @@
 
         @param roomJID: The room jabber/xmpp entity id.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param messages: The history to send to the room as an ordered list of
@@ -788 +787 @@
                          L{domish.Element}, and C{'timestamp'} with the
                          timestamp.
-        @type messages: L{list} of L{domish.Element}
+        @type messages: C{list} of L{domish.Element}
         """
 
@@ -817 +816 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @return: A deferred that fires with the room's configuration form as
@@ -838 +837 @@
 
         @param roomJID: The room to configure.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param options: A mapping of field names to values, or C{None} to
@@ -885 +884 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._getAffiliationList(roomJID, 'member')
@@ -895 +894 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._getAffiliationList(roomJID, 'admin')
@@ -905 +904 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._getAffiliationList(roomJID, 'outcast')
@@ -915 +914 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._getAffiliationList(roomJID, 'owner')
@@ -925 +924 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         d = self._getRoleList(roomJID, 'moderator')
@@ -961 +960 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param entities: The list of entities to change for a room.
-        @type entities: L{list} of L{jid.JID}
+        @type entities: C{list} of
+            L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param affiliation: The affilation to the entities will acquire.
@@ -970 +970 @@
 
         @param sender: The entity sending the request.
-        @type sender: L{jid.JID}
+        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         """
@@ -986 +986 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nick: The nick name for the user in this room.
@@ -995 +995 @@
 
         @param sender: The entity sending the request.
-        @type sender: L{jid.JID}
+        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._setRole(roomJID, nick=nick,
@@ -1009 +1009 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nick: The nick name for the user in this room.
@@ -1018 +1018 @@
 
         @param sender: The entity sending the request.
-        @type sender: L{jid.JID}
+        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._setRole(roomJID, nick=nick, role='visitor',
@@ -1029 +1029 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nick: The nick name for the user in this room.
@@ -1038 +1038 @@
 
         @param sender: The entity sending the request.
-        @type sender: L{jid.JID}
+        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._setRole(roomJID, nick=nick, role='moderator',
@@ -1049 +1049 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param entity: The bare JID of the entity to be banned.
-        @type entity: L{jid.JID}
+        @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param reason: The reason for banning the entity.
@@ -1058 +1058 @@
 
         @param sender: The entity sending the request.
-        @type sender: L{jid.JID}
+        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._setAffiliation(roomJID, entity, 'outcast',
@@ -1069 +1069 @@
 
         @param roomJID: The bare JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nick: The occupant to be banned.
@@ -1078 +1078 @@
 
         @param sender: The entity sending the request.
-        @type sender: L{jid.JID}
+        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._setRole(roomJID, nick, 'none',
@@ -1089 +1089 @@
 
         @param roomJID: The JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param reason: The reason for the destruction of the room.
@@ -1095 +1095 @@
 
         @param alternate: The JID of the room suggested as an alternate venue.
-        @type alternate: L{jid.JID}
+        @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         """
@@ -1129 +1129 @@
 
     @ivar roomJID: The Room JID of the MUC room.
-    @type roomJID: L{JID}
+    @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
     @ivar nick: The nick name for the client in this room.
@@ -1136 +1136 @@
     @ivar occupantJID: The JID of the occupant in the room. Generated from
         roomJID and nick.
-    @type occupantJID: L{jid.JID}
+    @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
     @ivar locked: Flag signalling a locked room. A locked room first needs
@@ -1208 +1208 @@
     Multi-User Chat client protocol.
 
-    This is a subclass of L{XMPPHandler} and implements L{IMUCCLient}.
+    This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.
 
     @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the
@@ -1244 +1244 @@
         the L{Room} instance associated with it.
 
-        @type occupantJID: L{jid.JID}
+        @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         return self._rooms.get(roomJID)
@@ -1437 +1437 @@
 
         @param roomJID: The JID of the room the entity is joining.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nick: The nick name for the entitity joining the room.
@@ -1481 +1481 @@
 
         @param roomJID: The JID of the room, i.e. without a resource.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nick: The new nick name within the room.
@@ -1505 +1505 @@
 
         @param roomJID: The Room JID of the room to leave.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
         """
         def cb(presence):
@@ -1522 +1522 @@
 
         @param roomJID: The Room JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param show: The availability of the entity. Common values are xa,
@@ -1542 +1542 @@
 
         @param roomJID: The JID of the room.
-        @type roomJID: L{jid.JID}
+        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param reason: The reason for the destruction of the room.
@@ -1548 +1548 @@
 
         @param alternate: The JID of the room suggested as an alternate venue.
-        @type alternate: L{jid.JID}
+        @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         """