improve docs

This commit is contained in:
2025-05-21 17:44:24 +02:00
parent 35ca1f0eee
commit eebacd5fb9
3 changed files with 79 additions and 35 deletions

View File

@@ -6,15 +6,19 @@
#include "types.h"
/**
* Initializes the Bot object
* @param[out] bot The Bot object
* @param[in] token The Bot token (obtained from @BotFather)
* @brief Initializes the Bot object.
*
* @param[out] bot The Bot object.
* @param[in] token The Bot token (obtained from @BotFather).
*
* @return TGBOT_OK on success.
*/
tgbot_rc tgbot_init(tgbot *bot, char *token);
/**
* Cleans the memory
* @param bot The Bot object
* @brief Cleans the memory.
*
* @param[out] bot The Bot object.
*/
void tgbot_destroy(tgbot *bot);