Merge pull request #207 from vanitasvitae/descriptions

Add missing package-info.java descriptions.
This commit is contained in:
Florian Schmaus 2018-02-21 20:08:39 +01:00 committed by GitHub
commit 64f41364f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
145 changed files with 148 additions and 144 deletions

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Android classes for XEP-0199: XMPP Ping.
*/
package org.jivesoftware.smackx.ping.android;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Android classes for debugging purposes.
*/
package org.jivesoftware.smackx.debugger.android;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smack optional Debuggers.
*/
package org.jivesoftware.smackx.debugger;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smack classes for compression.
*/
package org.jivesoftware.smack.compression;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-280: Message Carbons.
* Smack's API for XEP-0280: Message Carbons.
*/
package org.jivesoftware.smackx.carbons;

View File

@ -16,6 +16,6 @@
*/
/**
* Stanzas and extension elements for XEP-280: Message Carbons.
* Stanzas and extension elements for XEP-0280: Message Carbons.
*/
package org.jivesoftware.smackx.carbons.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* Provider for XEP-280: Message Carbons.
* Provider for XEP-0280: Message Carbons.
*/
package org.jivesoftware.smackx.carbons.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-392: Consistent Color Generation.
* Smack's API for XEP-0392: Consistent Color Generation.
*/
package org.jivesoftware.smackx.colors;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-352: Client State Indication.
* Smack's API for XEP-0352: Client State Indication.
*/
package org.jivesoftware.smackx.csi;

View File

@ -16,6 +16,6 @@
*/
/**
* Plain stream elements for XEP-352: Client State Indication.
* Plain stream elements for XEP-0352: Client State Indication.
*/
package org.jivesoftware.smackx.csi.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* Provider for XEP-352: Client State Indication.
* Provider for XEP-0352: Client State Indication.
*/
package org.jivesoftware.smackx.csi.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-332: HTTP over XMPP transport.
* Smack's API for XEP-0332: HTTP over XMPP transport.
*/
package org.jivesoftware.smackx.hoxt;

View File

@ -16,6 +16,6 @@
*/
/**
* Stanzas and extension elements for XEP-332: HTTP over XMPP transport.
* Stanzas and extension elements for XEP-0332: HTTP over XMPP transport.
*/
package org.jivesoftware.smackx.hoxt.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* Providers for XEP-332: HTTP over XMPP transport.
* Providers for XEP-0332: HTTP over XMPP transport.
*/
package org.jivesoftware.smackx.hoxt.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* Extension elements for XEP-295: JSON Encodings for XMPP.
* Extension elements for XEP-0295: JSON Encodings for XMPP.
*/
package org.jivesoftware.smackx.json.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* Providers for XEP-295: JSON Encodings for XMPP.
* Providers for XEP-0295: JSON Encodings for XMPP.
*/
package org.jivesoftware.smackx.json.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks initializer for extensions.
*/
package org.jivesoftware.smack.extensions;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-33: Extended Stanza Addressing.
* Smack's API for XEP-0033: Extended Stanza Addressing.
*/
package org.jivesoftware.smackx.address;

View File

@ -16,6 +16,6 @@
*/
/**
* Stanzas and extension elements for XEP-33: Extended Stanzas Addressing.
* Stanzas and extension elements for XEP-0033: Extended Stanzas Addressing.
*/
package org.jivesoftware.smackx.address.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* Providers for XEP-33: Extended Stanza Addressing.
* Providers for XEP-0033: Extended Stanza Addressing.
*/
package org.jivesoftware.smackx.address.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-79: Advanced Message Processing.
* Smack's API for XEP-0079: Advanced Message Processing.
*/
package org.jivesoftware.smackx.amp;

View File

@ -16,6 +16,6 @@
*/
/**
* Stanzas and extension elements for XEP-79: Advanced Message Processing.
* Stanzas and extension elements for XEP-0079: Advanced Message Processing.
*/
package org.jivesoftware.smackx.amp.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* Providers for XEP-79: Advanced Message Processing.
* Providers for XEP-0079: Advanced Message Processing.
*/
package org.jivesoftware.smackx.amp.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-224: Attention.
* Smack's API for XEP-0224: Attention.
*/
package org.jivesoftware.smackx.attention;

View File

@ -16,6 +16,6 @@
*/
/**
* Stanzas and extension elements for XEP-224: Attention.
* Stanzas and extension elements for XEP-0224: Attention.
*/
package org.jivesoftware.smackx.attention.packet;

View File

@ -15,7 +15,7 @@
* limitations under the License.
*/
/**
* Classes and interfaces of Bits of Binary.
* Classes and interfaces of XEP-0231: Bits of Binary.
*
* @author Fernando Ramirez
* @see <a href="http://xmpp.org/extensions/xep-0231.html">XEP-0231: Bits of

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-48: Bookmarks.
* Smack's API for XEP-0048: Bookmarks.
*/
package org.jivesoftware.smackx.bookmarks;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-47: In-Band Bytestreams.
* Smack's API for XEP-0047: In-Band Bytestreams.
*/
package org.jivesoftware.smackx.bytestreams.ibb;

View File

@ -16,6 +16,6 @@
*/
/**
* Stanzas and extension elements for XEP-47: In-Band Bytestreams.
* Stanzas and extension elements for XEP-0047: In-Band Bytestreams.
*/
package org.jivesoftware.smackx.bytestreams.ibb.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* Providers for XEP-47: In-Band Bytestreams.
* Providers for XEP-0047: In-Band Bytestreams.
*/
package org.jivesoftware.smackx.bytestreams.ibb.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-65: SOCKS5 Bytestreams.
* Smack's API for XEP-0065: SOCKS5 Bytestreams, as well as XEP-0047: In-Band Bytestreams.
*/
package org.jivesoftware.smackx.bytestreams;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-65: SOCKS5 Bytestreams.
* Smack's API for XEP-0065: SOCKS5 Bytestreams.
*/
package org.jivesoftware.smackx.bytestreams.socks5;

View File

@ -16,6 +16,6 @@
*/
/**
* Stanzas and extension elements for XEP-65: SOCKS5 Bytestreams.
* Stanzas and extension elements for XEP-0065: SOCKS5 Bytestreams.
*/
package org.jivesoftware.smackx.bytestreams.socks5.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* Providers for XEP-65: SOCKS5 Bytestreams.
* Providers for XEP-0065: SOCKS5 Bytestreams.
*/
package org.jivesoftware.smackx.bytestreams.socks5.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Cache classes for XEP-0115: Entity Capabilities.
*/
package org.jivesoftware.smackx.caps.cache;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0115: Entity Capabilities.
*/
package org.jivesoftware.smackx.caps;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0115: Entity Capabilities.
*/
package org.jivesoftware.smackx.caps.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0115: Entity Capabilities.
*/
package org.jivesoftware.smackx.caps.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0085: Chat State Notifications.
*/
package org.jivesoftware.smackx.chatstates;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0085: Chat State Notifications.
*/
package org.jivesoftware.smackx.chatstates.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* Provider classes for Chat State Notifications (XEP-0085).
* Provider classes for XEP-0085: Chat State Notifications.
*/
package org.jivesoftware.smackx.chatstates.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0050: Ad-Hoc Commands.
*/
package org.jivesoftware.smackx.commands;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0050: Ad-Hoc Commands.
*/
package org.jivesoftware.smackx.commands.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0050: Ad-Hoc Commands.
*/
package org.jivesoftware.smackx.commands.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* StanzaFilter classes for XEP-0203: Delayed Delivery, as well as XEP-0091: Legacy Delayed Delivery.
*/
package org.jivesoftware.smackx.delay.filter;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0203: Delayed Delivery, as well as XEP-0091: Legacy Delayed Delivery.
*/
package org.jivesoftware.smackx.delay;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0203: Delayed Delivery, as well as XEP-0091: Legacy Delayed Delivery.
*/
package org.jivesoftware.smackx.delay.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0203: Delayed Delivery, as well as XEP-0091: Legacy Delayed Delivery.
*/
package org.jivesoftware.smackx.delay.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0030: Service Discovery.
*/
package org.jivesoftware.smackx.disco;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0030: Service Discovery.
*/
package org.jivesoftware.smackx.disco.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0030: Service Discovery.
*/
package org.jivesoftware.smackx.disco.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* File Transfers via XEP-0095: Stream Initialization.
*/
package org.jivesoftware.smackx.filetransfer;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0297: Stanza Forwarding.
*/
package org.jivesoftware.smackx.forward;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0297: Stanza Forwarding.
*/
package org.jivesoftware.smackx.forward.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0297: Stanza Forwarding.
*/
package org.jivesoftware.smackx.forward.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0080: User Location.
*/
package org.jivesoftware.smackx.geoloc;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0080: User Location.
*/
package org.jivesoftware.smackx.geoloc.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0080: User Location.
*/
package org.jivesoftware.smackx.geoloc.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0012: Last Activity.
*/
package org.jivesoftware.smackx.iqlast;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0012: Last Activity.
*/
package org.jivesoftware.smackx.iqlast.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0049: Private XML Storage.
*/
package org.jivesoftware.smackx.iqprivate;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0049: Private XML Storage.
*/
package org.jivesoftware.smackx.iqprivate.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0049: Private XML Storage.
*/
package org.jivesoftware.smackx.iqprivate.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0077: In-Band Registration.
*/
package org.jivesoftware.smackx.iqregister;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0077: In-Band Registration.
*/
package org.jivesoftware.smackx.iqregister.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0077: In-Band Registration.
*/
package org.jivesoftware.smackx.iqregister.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0092: Software Version.
*/
package org.jivesoftware.smackx.iqversion;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0092: Software Version.
*/
package org.jivesoftware.smackx.iqversion.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0092: Software Version.
*/
package org.jivesoftware.smackx.iqversion.provider;

View File

@ -16,6 +16,7 @@
*/
/**
* TODO describe me.
* Smacks implementation for attaching arbitrary properties to packets according to
* https://docs.jivesoftware.com/smack/latest/documentation/properties.html.
*/
package org.jivesoftware.smackx.jiveproperties;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes.
*/
package org.jivesoftware.smackx.jiveproperties.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes.
*/
package org.jivesoftware.smackx.jiveproperties.provider;

View File

@ -14,4 +14,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* XMPP stream element providers for Last Message Correction as defined in XEP-0308.
*/
package org.jivesoftware.smackx.message_correct.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* Classes and Interfaces that implement Multi-User Chat (MUC) as defined in XEP-45.
* Classes and Interfaces that implement Multi-User Chat (MUC) as defined in XEP-0045.
*/
package org.jivesoftware.smackx.muc;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0045: Multi-User Chat.
*/
package org.jivesoftware.smackx.muc.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0045: Multi-User Chat.
*/
package org.jivesoftware.smackx.muc.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0172: User Nickname.
*/
package org.jivesoftware.smackx.nick;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0172: User Nickname.
*/
package org.jivesoftware.smackx.nick.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0013: Flexible Offline Message Retrieval.
*/
package org.jivesoftware.smackx.offline;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0013: Flexible Offline Message Retrieval.
*/
package org.jivesoftware.smackx.offline.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Integration tests.
*/
package org.jivesoftware.smackx;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation XEP-0163: Personal Eventing Protocol.
*/
package org.jivesoftware.smackx.pep;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0199: XMPP Ping.
*/
package org.jivesoftware.smackx.ping;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0199: XMPP Ping.
*/
package org.jivesoftware.smackx.ping.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0199: XMPP Ping.
*/
package org.jivesoftware.smackx.ping.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Filters for XEP-0016: Privacy Lists.
*/
package org.jivesoftware.smackx.privacy.filter;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0016: Privacy Lists.
*/
package org.jivesoftware.smackx.privacy;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0016: Privacy Lists.
*/
package org.jivesoftware.smackx.privacy.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes for XEP-0016: Privacy Lists.
*/
package org.jivesoftware.smackx.privacy.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* Smack's API for XEP-60: Publish-Subscribe.
* Smack's API for XEP-0060: Publish-Subscribe.
*/
package org.jivesoftware.smackx.pubsub;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* XEP-0184: Message Delivery Receipts.
*/
package org.jivesoftware.smackx.receipts;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* XEP-0059: Result Set Management.
*/
package org.jivesoftware.smackx.rsm;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes of XEP-0059: Result Set Management.
*/
package org.jivesoftware.smackx.rsm.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Providers for XEP-0059: Result Set Management.
*/
package org.jivesoftware.smackx.rsm.provider;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0055: Jabber Search.
*/
package org.jivesoftware.smackx.search;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Implementation of shared groups. Will only work with Wildfire!
*/
package org.jivesoftware.smackx.sharedgroups;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes of shared groups.
*/
package org.jivesoftware.smackx.sharedgroups.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Smacks implementation of XEP-0131: Stanza Headers and Internet Metadata.
*/
package org.jivesoftware.smackx.shim;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Element classes for XEP-0131: Stanza Headers and Internet Metadata.
*/
package org.jivesoftware.smackx.shim.packet;

View File

@ -16,6 +16,6 @@
*/
/**
* TODO describe me.
* Provider classes of XEP-0131: Stanza Headers and Internet Metadata.
*/
package org.jivesoftware.smackx.shim.provider;

Some files were not shown because too many files have changed in this diff Show More