Documentaton generation completed

This commit is contained in:
David Cermak
2021-04-14 17:57:42 +02:00
parent d384cde725
commit 4bf8ab07ca
27 changed files with 509 additions and 88 deletions

View File

@ -3,10 +3,14 @@ C++ API Documentation
Similar to the :ref:`c_api`, the basic application workflow consist of
- Construction of the DCE
- Sending (AT) commands
- Switching modes
- Destroying the DCE
.. toctree::
- :ref:`Construction of the DCE<cpp_init>`
- :ref:`Switching modes<cpp_mode_switch>`
- :ref:`Sending (AT) commands<cpp_modem_commands>`
- :ref:`Destroying the DCE<cpp_destroy>`
.. _cpp_init:
Create DTE and DCE
------------------
@ -16,21 +20,22 @@ Create DTE and DCE
.. doxygengroup:: ESP_MODEM_INIT_DCE
.. _cpp_mode_switch:
Mode switching commands
-----------------------
.. doxygenclass:: esp_modem::DCE_T
:members:
.. _cpp_modem_commands:
Modem commands
--------------
Create the DCE object with DCE factory :cpp:func:`esp_modem_new`
.. doxygenclass:: DCE
:members:
.. include:: cxx_api_links.rst
.. _cpp_destroy:
Destroy the DCE
---------------