improve docs
This commit is contained in:
@@ -5,7 +5,7 @@
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* A structure used to get curl response
|
||||
* @brief A structure used to get curl response.
|
||||
*/
|
||||
struct memory_buffer {
|
||||
char *data;
|
||||
@@ -13,43 +13,43 @@ struct memory_buffer {
|
||||
};
|
||||
|
||||
/**
|
||||
* A structure to represent bot object
|
||||
* @brief A structure to represent bot object.
|
||||
*/
|
||||
struct tgbot_t {
|
||||
char token[128]; /**< Bot token */
|
||||
char api[512]; /**< Bot API url */
|
||||
int32_t offset; /**< Bot offset */
|
||||
CURL *curl; /**< Curl object, used to send http requests */
|
||||
char token[128]; /**< Bot token. */
|
||||
char api[512]; /**< Bot API url. */
|
||||
int32_t offset; /**< Bot offset. */
|
||||
CURL *curl; /**< Curl object, used to send http requests. */
|
||||
};
|
||||
typedef struct tgbot_t tgbot;
|
||||
|
||||
/**
|
||||
* A structure to represent Bot information got from getMe API
|
||||
* @brief A structure to represent Bot information got from getMe API.
|
||||
*/
|
||||
struct tgbot_me_t {
|
||||
char first_name[256];
|
||||
char username[32];
|
||||
char first_name[256]; /**< Bot's first name. */
|
||||
char username[32]; /**< Bot's username. */
|
||||
};
|
||||
typedef struct tgbot_me_t tgbot_me;
|
||||
|
||||
/**
|
||||
* A structure to represent Update object
|
||||
* @brief A structure to represent Update object.
|
||||
*/
|
||||
struct tgbot_update_t {
|
||||
int64_t update_id; /**< Update id */
|
||||
long message_id; /**< Message id */
|
||||
int64_t chat_id; /**< Chat id */
|
||||
char chat_first_name[256]; /**< Chat first name */
|
||||
char chat_last_name[256]; /**< Chat last name */
|
||||
char chat_username[32]; /**< Chat username */
|
||||
char chat_type[32]; /**< Chat type (private/public) */
|
||||
int32_t date; /**< Date in unix timestamp */
|
||||
char text[4096]; /**< Message text */
|
||||
int64_t update_id; /**< Update id. */
|
||||
long message_id; /**< Message id. */
|
||||
int64_t chat_id; /**< Chat id. */
|
||||
char chat_first_name[256]; /**< Chat first name. */
|
||||
char chat_last_name[256]; /**< Chat last name. */
|
||||
char chat_username[32]; /**< Chat username. */
|
||||
char chat_type[32]; /**< Chat type (private/public). */
|
||||
int32_t date; /**< Date in unix timestamp. */
|
||||
char text[4096]; /**< Message text. */
|
||||
};
|
||||
typedef struct tgbot_update_t tgbot_update;
|
||||
|
||||
/**
|
||||
* A structure to represent CallbackQuery object
|
||||
* @brief A structure to represent CallbackQuery object.
|
||||
*/
|
||||
struct tgbot_cbquery_t {
|
||||
int64_t update_id;
|
||||
@@ -59,17 +59,17 @@ struct tgbot_cbquery_t {
|
||||
int32_t date;
|
||||
char text[4096];
|
||||
char chat_instance[128];
|
||||
char data[64]; /**> Callback data */
|
||||
char data[64]; /**> Callback data. */
|
||||
};
|
||||
typedef struct tgbot_cbquery_t tgbot_cbquery;
|
||||
|
||||
/**
|
||||
* Callback function pointer
|
||||
* @brief Callback function pointer.
|
||||
*/
|
||||
typedef void (*Callback)(tgbot *bot, tgbot_cbquery *query);
|
||||
|
||||
/**
|
||||
* A structure to represent error codes
|
||||
* @brief A structure to represent error codes.
|
||||
*/
|
||||
enum tgbot_rc {
|
||||
TGBOT_OK = 0,
|
||||
|
||||
Reference in New Issue
Block a user