From 6ec52c782fff5b5c88d8ab6778b276836d215772 Mon Sep 17 00:00:00 2001 From: 2bndy5 <2bndy5@gmail.com> Date: Sat, 30 Oct 2021 08:40:13 -0700 Subject: [PATCH] document deprecated stuff in sphinx --- docs/sphinx/classRF24.rst | 8 ++++++-- docs/sphinx/index.rst | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/classRF24.rst b/docs/sphinx/classRF24.rst index 69a0e6318..a29f490dc 100644 --- a/docs/sphinx/classRF24.rst +++ b/docs/sphinx/classRF24.rst @@ -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) @@ -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 ============ @@ -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 diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index 0fd1be2fa..52e791372 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -19,9 +19,9 @@ Site Index classRF24 enums - deprecated nRF24L01_8h RF24_config_8h + deprecated .. toctree::