Skip to content

Commit

Permalink
document deprecated stuff in sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Oct 30, 2021
1 parent 741a508 commit 6ec52c7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions docs/sphinx/classRF24.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ RF24 class

.. cpp:class:: RF24

.. doxygenfunction:: RF24::RF24 (uint16_t,uint16_t,uint32_t)
.. doxygenfunction:: RF24::RF24 (uint32_t _spi_speed=RF24_SPI_SPEED)

Basic API
============

.. doxygenfunction:: RF24::RF24 (uint16_t,uint16_t,uint32_t)
.. doxygenfunction:: RF24::RF24 (uint32_t _spi_speed=RF24_SPI_SPEED)
.. doxygenfunction:: RF24::begin (void)
.. doxygenfunction:: RF24::begin (_SPI *spiBus)
.. doxygenfunction:: RF24::begin (_SPI *spiBus, uint16_t _cepin, uint16_t _cspin)
Expand All @@ -19,7 +20,9 @@ Basic API
.. doxygenfunction:: RF24::read
.. doxygenfunction:: RF24::write (const void *buf, uint8_t len)
.. doxygenfunction:: RF24::openWritingPipe (const uint8_t *address)
.. doxygenfunction:: RF24::openWritingPipe (uint64_t address)
.. doxygenfunction:: RF24::openReadingPipe (uint8_t number, const uint8_t *address)
.. doxygenfunction:: RF24::openReadingPipe (uint8_t number, uint64_t address)

Advanced API
============
Expand All @@ -38,6 +41,7 @@ Advanced API
.. doxygenfunction:: RF24::txStandBy()
.. doxygenfunction:: RF24::txStandBy (uint32_t timeout, bool startTx=0)
.. doxygenfunction:: RF24::writeAckPayload
.. doxygenfunction:: RF24::isAckPayloadAvailable
.. doxygenfunction:: RF24::whatHappened
.. doxygenfunction:: RF24::startFastWrite
.. doxygenfunction:: RF24::startWrite
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Site Index

classRF24
enums
deprecated
nRF24L01_8h
RF24_config_8h
deprecated


.. toctree::
Expand Down

0 comments on commit 6ec52c7

Please sign in to comment.