Verified Commit 7b0c7458 authored by Linus Jahn's avatar Linus Jahn 🔌 Committed by Linus Jahn
Browse files

gloox-extensions: Update documentation of XEPs

This adds the author, since and XEP Version information to all files.
parent 3f7b11c4
......@@ -38,7 +38,12 @@ namespace gloox {
/**
* @class BitsOfBinaryCache A virtual interface that enables objects to
* cache Bits of Binary data.
* cache Bits of Binary (@xep{0231}) data.
*
* XEP Version: 1.0
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0.21
*/
class BitsOfBinaryCache
{
......
......@@ -39,6 +39,11 @@ namespace gloox {
/**
* @class BitsOfBinaryData An implementation of Bits of Binary (@xep{0231})
* as a StanzaExtension.
*
* XEP Version: 1.0
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0.21
*/
class GLOOX_API BitsOfBinaryData : public gloox::StanzaExtension
{
......
......@@ -39,6 +39,11 @@ namespace gloox {
/**
* @class BitsOfBinaryHandler A virtual interface that enables objects to
* receive Bits of Binary (@xep{0231}) events.
*
* XEP Version: 1.0
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0.21
*/
class BitsOfBinaryHandler
{
......
......@@ -40,7 +40,13 @@ namespace gloox {
class BitsOfBinaryHandler;
/**
* @todo write docs
* @class BitsOfBinaryManager A manager for handling incoming
* @c BitsOfBinaryData requests and replys. (@xep{0231})
*
* XEP Version: 1.0
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0.21
*/
class BitsOfBinaryManager : IqHandler
{
......
......@@ -38,6 +38,11 @@ namespace gloox {
/**
* @class BitsOfBinaryMemoryCache An implementation of an @c BitsOfBinaryCache
* using main memory for caching.
*
* XEP Version: 0.5
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0.21
*/
class GLOOX_API BitsOfBinaryMemoryCache : gloox::BitsOfBinaryCache
{
......
......@@ -44,6 +44,11 @@ namespace gloox {
* that can be used with @c HttpUploadManager.
*
* This class is only used for uploading files from disk to the server.
*
* XEP Version: 0.5
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0.21
*/
class GLOOX_API HttpUploader
{
......
......@@ -42,6 +42,13 @@ namespace gloox {
/**
* @class HttpUploadHandler A virtual interface that enables objects to
* receive HTTP File Upload (@xep{0363}) events.
*
* It can be registered at the @c HttpUploadManager.
*
* XEP Version: 0.5
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0.21
*/
class GLOOX_API HttpUploadHandler
{
......
......@@ -43,7 +43,8 @@ namespace gloox {
class HttpUploader;
/**
* @brief An manager that handles upload services and can upload files (@xep{0363}).
* @class HttpUploadManager A manager that handles upload services and
* can upload files (@xep{0363}).
*
* First, you need to register the HTTP File Upload stanza extensions to
* make them usable in your gloox @c Client.
......@@ -134,7 +135,7 @@ namespace gloox {
* XEP Version: 0.5
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0
* @since 1.0.21
*/
class GLOOX_API HttpUploadManager : public IqHandler
{
......
......@@ -35,6 +35,18 @@
#include <gloox/gloox.h>
namespace gloox {
/**
* @class HttpUploadRequest The request to get an @c HttpUploadSlot for
* uploading a file to an HTTP server, implemented as StanzaExtension.
* (@xep{0363})
*
* @c HttpUploadManager for details how to use it.
*
* XEP Version: 0.5
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0.21
*/
class GLOOX_API HttpUploadRequest : public StanzaExtension
{
public:
......
......@@ -36,6 +36,17 @@
#include "gloox-extensions.h"
namespace gloox {
/**
* @class HttpUploadSlot The result of an @c HttpUploadRequest returned
* from the server, implemented as StanzaExtension. (@xep{0363})
*
* @c HttpUploadManager for details how to use it.
*
* XEP Version: 0.5
*
* @author Linus Jahn <lnj@kaidan.im>
* @since 1.0.21
*/
class GLOOX_API HttpUploadSlot : public StanzaExtension
{
public:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment