Documentation hosted in this repository is mostly generated using doxygen.
The only changes that should be made directly to this repository would be anything in the index.html or the RF24Installer/RPi folder.
If you wish to contribute documentation changes, you must
-
be familiar with doxygen (especially doxygen's special commands). It also helps to know Markdown syntax because that is (mostly) the syntax that doxygen uses.
-
make your changes to the appropriate header file in the reository related to the library documentation you wish to change.
Library Repository RF24 nRF24/RF24 RF24Network nRF24/RF24Network RF24Mesh nRF24/RF24Mesh RF24Ethernet nRF24/RF24Ethernet AutoAnalogAudio TMRh20/AutoAnalogAudio RF24Audio nRF24/RF24Audio -
submit a Pull Request in the repository for which you changed.
- If your changes are related to AutoAnalogAudio or TMRpcm libraries, then a second Pull Request needs to be submitted to this repository. This second Pull Request should only contain the doxygen output of the new documentation.
The TMRh20/TMRpcm library uses Wiki pages for its documentation. Again, please submit your changes for that documentation to TMRh20's TMRpcm repository.