Ignore:
Timestamp:
Jan 23, 2012, 3:48:48 PM (10 years ago)
Author:
Ralph Meijer <ralphm@…>
Branch:
default
Message:

Documentation fixes for pydoctor.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wokkel/muc.py

    r162 r166  
    228228
    229229    @param alternate: Optional room JID of an alternate venue.
    230     @type alternate: L{jid.JID}
     230    @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}
    231231
    232232    @param password: Optional password for entering the alternate venue.
     
    398398
    399399    @ivar entity: The real JID of the entity this presence is from.
    400     @type entity: L{jid.JID}
     400    @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
    401401
    402402    @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.
     
    500500        Called when the XML stream has been initialized.
    501501
    502         It initializes several XPath events to handle MUC stanzas that come in.
    503         After those are initialized the method L{initialized} is called to
    504         signal that we have finished.
     502        It initializes several XPath events to handle MUC stanzas that come
     503        in.
    505504        """
    506505        xmppim.BasePresenceProtocol.connectionInitialized(self)
     
    547546        @param timeout: The number of seconds to wait before the deferred is
    548547            timed out.
    549         @type timeout: L{int}
     548        @type timeout: C{int}
    550549
    551550        The deferred object L{defer.Deferred} is returned.
     
    590589
    591590        @param roomJID: The JID of the room the entity is joining.
    592         @type roomJID: L{jid.JID}
     591        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    593592
    594593        @param nick: The nick name for the entitity joining the room.
     
    623622
    624623        @param roomJID: The JID of the room.
    625         @type roomJID: L{jid.JID}
     624        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    626625
    627626        @param nick: The new nick name within the room.
     
    640639
    641640        @param roomJID: The Room JID of the room.
    642         @type roomJID: L{jid.JID}
     641        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    643642
    644643        @param show: The availability of the entity. Common values are xa,
     
    662661
    663662        @param roomJID: The JID of the room.
    664         @type roomJID: L{jid.JID}
     663        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    665664        """
    666665        occupantJID = self._roomOccupantMap[roomJID]
     
    686685
    687686        @param occupantJID: The Room JID of the other user.
    688         @type occupantJID: L{jid.JID}
     687        @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    689688        """
    690689        message = PrivateChat(recipient=occupantJID, body=body)
     
    699698
    700699        @param roomJID: The bare JID of the room.
    701         @type roomJID: L{jid.JID}
     700        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    702701
    703702        @param subject: The subject you want to set.
     
    715714
    716715        @param roomJID: The bare JID of the room.
    717         @type roomJID: L{jid.JID}
     716        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    718717
    719718        @param invitee: The entity that is being invited.
    720         @type invitee: L{jid.JID}
     719        @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}
    721720
    722721        @param reason: The reason for the invite.
     
    734733        @param room: The room jabber/xmpp entity id for the requested
    735734            registration form.
    736         @type room: L{jid.JID}
     735        @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}
    737736        """
    738737        def cb(response):
     
    751750
    752751        @param roomJID: The bare JID of the room.
    753         @type roomJID: L{jid.JID}
     752        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    754753
    755754        @param options: A mapping of field names to values, or C{None} to
     
    768767
    769768        @param roomJID: The room jabber/xmpp entity id.
    770         @type roomJID: L{jid.JID}
     769        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    771770        """
    772771        message = VoiceRequest(recipient=roomJID)
     
    781780
    782781        @param roomJID: The room jabber/xmpp entity id.
    783         @type roomJID: L{jid.JID}
     782        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    784783
    785784        @param messages: The history to send to the room as an ordered list of
     
    788787                         L{domish.Element}, and C{'timestamp'} with the
    789788                         timestamp.
    790         @type messages: L{list} of L{domish.Element}
     789        @type messages: C{list} of L{domish.Element}
    791790        """
    792791
     
    817816
    818817        @param roomJID: The bare JID of the room.
    819         @type roomJID: L{jid.JID}
     818        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    820819
    821820        @return: A deferred that fires with the room's configuration form as
     
    838837
    839838        @param roomJID: The room to configure.
    840         @type roomJID: L{jid.JID}
     839        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    841840
    842841        @param options: A mapping of field names to values, or C{None} to
     
    885884
    886885        @param roomJID: The bare JID of the room.
    887         @type roomJID: L{jid.JID}
     886        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    888887        """
    889888        return self._getAffiliationList(roomJID, 'member')
     
    895894
    896895        @param roomJID: The bare JID of the room.
    897         @type roomJID: L{jid.JID}
     896        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    898897        """
    899898        return self._getAffiliationList(roomJID, 'admin')
     
    905904
    906905        @param roomJID: The bare JID of the room.
    907         @type roomJID: L{jid.JID}
     906        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    908907        """
    909908        return self._getAffiliationList(roomJID, 'outcast')
     
    915914
    916915        @param roomJID: The bare JID of the room.
    917         @type roomJID: L{jid.JID}
     916        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    918917        """
    919918        return self._getAffiliationList(roomJID, 'owner')
     
    925924
    926925        @param roomJID: The bare JID of the room.
    927         @type roomJID: L{jid.JID}
     926        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    928927        """
    929928        d = self._getRoleList(roomJID, 'moderator')
     
    961960
    962961        @param roomJID: The bare JID of the room.
    963         @type roomJID: L{jid.JID}
     962        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    964963
    965964        @param entities: The list of entities to change for a room.
    966         @type entities: L{list} of L{jid.JID}
     965        @type entities: C{list} of
     966            L{JID<twisted.words.protocols.jabber.jid.JID>}
    967967
    968968        @param affiliation: The affilation to the entities will acquire.
     
    970970
    971971        @param sender: The entity sending the request.
    972         @type sender: L{jid.JID}
     972        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    973973
    974974        """
     
    986986
    987987        @param roomJID: The bare JID of the room.
    988         @type roomJID: L{jid.JID}
     988        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    989989
    990990        @param nick: The nick name for the user in this room.
     
    995995
    996996        @param sender: The entity sending the request.
    997         @type sender: L{jid.JID}
     997        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    998998        """
    999999        return self._setRole(roomJID, nick=nick,
     
    10091009
    10101010        @param roomJID: The bare JID of the room.
    1011         @type roomJID: L{jid.JID}
     1011        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10121012
    10131013        @param nick: The nick name for the user in this room.
     
    10181018
    10191019        @param sender: The entity sending the request.
    1020         @type sender: L{jid.JID}
     1020        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10211021        """
    10221022        return self._setRole(roomJID, nick=nick, role='visitor',
     
    10291029
    10301030        @param roomJID: The bare JID of the room.
    1031         @type roomJID: L{jid.JID}
     1031        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10321032
    10331033        @param nick: The nick name for the user in this room.
     
    10381038
    10391039        @param sender: The entity sending the request.
    1040         @type sender: L{jid.JID}
     1040        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10411041        """
    10421042        return self._setRole(roomJID, nick=nick, role='moderator',
     
    10491049
    10501050        @param roomJID: The bare JID of the room.
    1051         @type roomJID: L{jid.JID}
     1051        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10521052
    10531053        @param entity: The bare JID of the entity to be banned.
    1054         @type entity: L{jid.JID}
     1054        @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10551055
    10561056        @param reason: The reason for banning the entity.
     
    10581058
    10591059        @param sender: The entity sending the request.
    1060         @type sender: L{jid.JID}
     1060        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10611061        """
    10621062        return self._setAffiliation(roomJID, entity, 'outcast',
     
    10691069
    10701070        @param roomJID: The bare JID of the room.
    1071         @type roomJID: L{jid.JID}
     1071        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10721072
    10731073        @param nick: The occupant to be banned.
     
    10781078
    10791079        @param sender: The entity sending the request.
    1080         @type sender: L{jid.JID}
     1080        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10811081        """
    10821082        return self._setRole(roomJID, nick, 'none',
     
    10891089
    10901090        @param roomJID: The JID of the room.
    1091         @type roomJID: L{jid.JID}
     1091        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10921092
    10931093        @param reason: The reason for the destruction of the room.
     
    10951095
    10961096        @param alternate: The JID of the room suggested as an alternate venue.
    1097         @type alternate: L{jid.JID}
     1097        @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10981098
    10991099        """
     
    11291129
    11301130    @ivar roomJID: The Room JID of the MUC room.
    1131     @type roomJID: L{JID}
     1131    @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    11321132
    11331133    @ivar nick: The nick name for the client in this room.
     
    11361136    @ivar occupantJID: The JID of the occupant in the room. Generated from
    11371137        roomJID and nick.
    1138     @type occupantJID: L{jid.JID}
     1138    @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    11391139
    11401140    @ivar locked: Flag signalling a locked room. A locked room first needs
     
    12081208    Multi-User Chat client protocol.
    12091209
    1210     This is a subclass of L{XMPPHandler} and implements L{IMUCCLient}.
     1210    This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.
    12111211
    12121212    @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the
     
    12441244        the L{Room} instance associated with it.
    12451245
    1246         @type occupantJID: L{jid.JID}
     1246        @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    12471247        """
    12481248        return self._rooms.get(roomJID)
     
    14371437
    14381438        @param roomJID: The JID of the room the entity is joining.
    1439         @type roomJID: L{jid.JID}
     1439        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    14401440
    14411441        @param nick: The nick name for the entitity joining the room.
     
    14811481
    14821482        @param roomJID: The JID of the room, i.e. without a resource.
    1483         @type roomJID: L{jid.JID}
     1483        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    14841484
    14851485        @param nick: The new nick name within the room.
     
    15051505
    15061506        @param roomJID: The Room JID of the room to leave.
    1507         @type roomJID: L{jid.JID}
     1507        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    15081508        """
    15091509        def cb(presence):
     
    15221522
    15231523        @param roomJID: The Room JID of the room.
    1524         @type roomJID: L{jid.JID}
     1524        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    15251525
    15261526        @param show: The availability of the entity. Common values are xa,
     
    15421542
    15431543        @param roomJID: The JID of the room.
    1544         @type roomJID: L{jid.JID}
     1544        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    15451545
    15461546        @param reason: The reason for the destruction of the room.
     
    15481548
    15491549        @param alternate: The JID of the room suggested as an alternate venue.
    1550         @type alternate: L{jid.JID}
     1550        @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}
    15511551
    15521552        """
Note: See TracChangeset for help on using the changeset viewer.