]> granicus.if.org Git - esp-idf/commitdiff
Merge with master; merge Doxygen config
authorJeroen Domburg <git@j0h.nl>
Thu, 17 Nov 2016 12:21:12 +0000 (20:21 +0800)
committerJeroen Domburg <git@j0h.nl>
Thu, 17 Nov 2016 12:21:12 +0000 (20:21 +0800)
1  2 
docs/Doxyfile
docs/index.rst

diff --combined docs/Doxyfile
index d5970ee5e908aec30e00df458dcc8ba5d9c1ed2a,0e4549a10f87913d54c6cce9d0284b5c07ac691a..1f53a85931bee33058278247da41fc844d9986a5
@@@ -1,8 -1,12 +1,14 @@@
  PROJECT_NAME = "ESP32 Programming Guide"
  
- INPUT = ../components/esp32/include/esp_wifi.h ../components/driver/include/driver ../components/bt/include \
-               ../components/nvs_flash/include ../components/log/include ../components/vfs/include \
-               ../components/esp32/include/esp_int_wdt.h ../components/esp32/include/esp_task_wdt.h
+ INPUT = ../components/esp32/include/esp_wifi.h \
+       ../components/driver/include/driver \
+       ../components/bt/include \
+       ../components/nvs_flash/include \
+       ../components/log/include \
+       ../components/vfs/include \
 -      ../components/spi_flash/include
++      ../components/spi_flash/include \
++      ../components/esp32/include/esp_int_wdt.h \
++      ../components/esp32/include/esp_task_wdt.h
  
  WARN_NO_PARAMDOC      = YES
  
@@@ -16,9 -20,8 +22,8 @@@ XML_OUTPUT            = xm
  GENERATE_HTML         = NO
  HAVE_DOT              = NO
  GENERATE_LATEX                = NO
- GENERATE_MAN          = NO
+ GENERATE_MAN          = YES
  GENERATE_RTF          = NO
  
- QUIET = YES
  WARN_LOGFILE = "doxygen-warning-log.txt"
  
diff --combined docs/index.rst
index c19fc52c9accf9135faeba2e49bee7e554bec7e2,f777d10caf8c94f7d44f2c788251c83675efb359..8bc7a72f29d40992b8b869d224454a9fb23c0938
@@@ -28,6 -28,7 +28,7 @@@ Contents
     :caption: What Else?
     :maxdepth: 1
     
+    General Notes <general-notes>
     partition-tables
     build_system
     openocd
@@@ -42,9 -43,9 +43,9 @@@
       1.2. Application startup flow - TBA
       1.3. Flash encryption and secure boot: how they work and APIs - TBA
       1.4. Lower Power Coprocessor - TBA
 -     1.5. Watchdogs
 +     1.5. Watchdogs <api/wdts>
       1.6. ...
 -   2. Memeory - TBA
 +   2. Memory - TBA
       2.1. Memory layout of the application (IRAM/IROM, limitations of each) - TBA
       2.2. Flash layout and partitions - TBA
       2.3. Flash access APIs - TBA
  
     Wi-Fi <api/esp_wifi>
     Bluetooth <api/bt>
 +   Watchdogs <api/wdts>
  
     api/gpio
     api/uart
     api/ledc
-  
+    SPI Flash and Partition APIs <api/spi_flash>
     Logging <api/log>
     Non-Volatile Storage <api/nvs_flash>
     Virtual Filesystem <api/vfs>