mirror of
https://github.com/manuelbl/ttn-esp32.git
synced 2025-07-13 22:42:52 +02:00
Improved API documentation
This commit is contained in:
@ -633,7 +633,7 @@ FORCE_LOCAL_INCLUDES = NO
|
||||
# documentation for inline members.
|
||||
# The default value is: YES.
|
||||
|
||||
INLINE_INFO = YES
|
||||
INLINE_INFO = NO
|
||||
|
||||
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
|
||||
# (detailed) documentation of file and class members alphabetically by member
|
||||
@ -865,7 +865,7 @@ WARN_LOGFILE =
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = ../include \
|
||||
mainpage.h
|
||||
doc.dox
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||
|
21
doc/doc.dox
Normal file
21
doc/doc.dox
Normal file
@ -0,0 +1,21 @@
|
||||
/*!
|
||||
\mainpage ttn-esp32 API Documentation
|
||||
|
||||
ttn-esp32 is a C and C++ library for the ESP-IDF (ESP32) framework
|
||||
for The Things Network library end devices using Semtech SX127x chips.
|
||||
|
||||
|
||||
\section cplusplus C++ API
|
||||
|
||||
\ref TheThingsNetwork class
|
||||
|
||||
\ref TTNRFSettings struct
|
||||
|
||||
|
||||
\section c C API
|
||||
|
||||
\ref c_api
|
||||
|
||||
\ref ttn_rf_settings_t struct
|
||||
|
||||
*/
|
@ -1,2 +1,3 @@
|
||||
#!/bin/sh
|
||||
rm -rf html
|
||||
doxygen Doxyfile
|
||||
|
@ -1,8 +0,0 @@
|
||||
/*! \mainpage ttn-esp32 – The Things Network library for ESP32
|
||||
*
|
||||
* This library for ESP-IDF (ESP32) supports devices with Semtech SX127x chips.
|
||||
*
|
||||
* \ref TheThingsNetwork class
|
||||
*
|
||||
* \ref ttn.h C functions
|
||||
*/
|
Reference in New Issue
Block a user