This repository has been archived by the owner on Apr 8, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added functions and objects to docs
- Loading branch information
Showing
21 changed files
with
936 additions
and
103 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
Funções | ||
======= | ||
|
||
Aqui você encontra as funções implementadas pela biblioteca. | ||
|
||
Funções exclusivas | ||
------------------ | ||
|
||
Funções que são implementadas pela biblioteca, mas não pela API do Telegram. | ||
|
||
.. c:function:: void framebot_init () | ||
Essa função é utilizada para iniciar a biblioteca e suas dependencias. | ||
.. c:function:: Bot *framebot (const char *token) | ||
Essa função é chamada para inicializar um objeto do tipo :c:type:`Bot`, | ||
que será usado sempre que for preciso utilizar uma função da API do Telegram. | ||
.. _api-func: | ||
Funções da API | ||
-------------- | ||
.. c:function:: User *get_me (const char *token) | ||
Veja em `Telegram API`_ | ||
.. _`Telegram API`: https://core.telegram.org/bots/api#getme | ||
Uma função para testar seu `token`. | ||
Requer o parâmetro `token`, e retorna as informações básicas do seu bot em um objeto :c:type:`User`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,15 @@ | ||
.. Framebot documentation master file, created by | ||
sphinx-quickstart on Sat Feb 24 20:48:01 2018. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
Framebot - Documentação | ||
======================= | ||
|
||
Welcome to Framebot's documentation! | ||
==================================== | ||
`Framebot` é um framework escrito C com o objetivo de ajudar programadores a criarem chat bots | ||
para o `Telegram`_. | ||
|
||
.. _`Telegram`: https://core.telegram.org/bots/api | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Contents: | ||
:caption: Conteúdo: | ||
|
||
starting | ||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` | ||
objects | ||
functions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
Objetos | ||
======= | ||
|
||
Aqui você encontra os objetos implementados pela biblioteca. | ||
|
||
Objetos exclusivos | ||
------------------ | ||
|
||
Objetos que existem somente na biblioteca, e não possuem representação na API do Telegram. | ||
|
||
.. c:type:: Bot | ||
Objeto que vai ser utilizado para referenciar seu bot nas funções da API. | ||
|
||
.. c:member:: char *token | ||
Seu `token` do Telegram. | ||
|
||
.. c:member:: User *user | ||
Objeto retornado da chamada à :c:func:`get_me` | ||
|
||
Objetos da API | ||
-------------- | ||
|
||
.. c:type:: User | ||
Veja `Telegram User`_ | ||
|
||
.. _`Telegram User`: https://core.telegram.org/bots/api#user | ||
|
||
.. c:member:: long int id | ||
.. c:member:: bool is_bot | ||
.. c:member:: char *first_name | ||
.. c:member:: char *last_name | ||
.. c:member:: char *username | ||
.. c:member:: char *language_code | ||
.. c:member:: struct _user *next |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.