Documentation/examples: format the first header as in other files

anchao · Oct 24, 2023 · 24bc270 · 24bc270
1 parent 731eaef
commit 24bc270
Show file tree

Hide file tree

Showing 178 changed files with 187 additions and 9 deletions.
diff --git a/Documentation/applications/examples/abntcodi/index.rst b/Documentation/applications/examples/abntcodi/index.rst
@@ -1,3 +1,4 @@
+==============================
 ``abntcodi`` ABNT CODI example
 ==============================
 

diff --git a/Documentation/applications/examples/adc/index.rst b/Documentation/applications/examples/adc/index.rst
@@ -1,3 +1,4 @@
+=====================
 ``adc`` Read from ADC
 =====================
 

diff --git a/Documentation/applications/examples/adjtime/index.rst b/Documentation/applications/examples/adjtime/index.rst
@@ -1,3 +1,4 @@
+====================================
 ``adjtime`` Ajdtime function example
 ====================================
 

diff --git a/Documentation/applications/examples/adxl372_test/index.rst b/Documentation/applications/examples/adxl372_test/index.rst
@@ -1,3 +1,4 @@
+=====================================
 ``adxl372_test`` ADXL372 test program
 =====================================
 

diff --git a/Documentation/applications/examples/ajoystick/index.rst b/Documentation/applications/examples/ajoystick/index.rst
@@ -1,3 +1,4 @@
+=============================
 ``ajoystick`` Analog Joystick
 =============================
 

diff --git a/Documentation/applications/examples/alarm/index.rst b/Documentation/applications/examples/alarm/index.rst
@@ -1,3 +1,4 @@
+===================
 ``alarm`` RTC Alarm
 ===================
 

diff --git a/Documentation/applications/examples/apa102/index.rst b/Documentation/applications/examples/apa102/index.rst
@@ -1,3 +1,4 @@
+==========================================
 ``apa102`` Rainbow on ``APA102`` LED Strip
 ==========================================
 

diff --git a/Documentation/applications/examples/apds9960/index.rst b/Documentation/applications/examples/apds9960/index.rst
@@ -1,3 +1,4 @@
+======================================
 ``apds9960`` APDS-9960 test pplication
 ======================================
 

diff --git a/Documentation/applications/examples/audio_rttl/index.rst b/Documentation/applications/examples/audio_rttl/index.rst
@@ -1,3 +1,4 @@
+===================================
 ``audio_rttl`` Audio tone generator
 ===================================
 

diff --git a/Documentation/applications/examples/bastest/index.rst b/Documentation/applications/examples/bastest/index.rst
@@ -1,3 +1,4 @@
+=================================
 ``bastest`` Bas BASIC Interpreter
 =================================
 

diff --git a/Documentation/applications/examples/battery/index.rst b/Documentation/applications/examples/battery/index.rst
@@ -1,3 +1,4 @@
+===================================
 ``battery`` Battery monitor example
 ===================================
 

diff --git a/Documentation/applications/examples/bme680/index.rst b/Documentation/applications/examples/bme680/index.rst
@@ -1,3 +1,4 @@
+================================
 ``bme680`` BME680 sensor example
 ================================
 

diff --git a/Documentation/applications/examples/bmi160/index.rst b/Documentation/applications/examples/bmi160/index.rst
@@ -1,3 +1,4 @@
+================================
 ``bmi160`` BMI160 sensor example
 ================================
 

diff --git a/Documentation/applications/examples/bmp180/index.rst b/Documentation/applications/examples/bmp180/index.rst
@@ -1,3 +1,4 @@
+==========================================
 ``bmp180`` BMP180 Barometer sensor example
 ==========================================
 

diff --git a/Documentation/applications/examples/bmp280/index.rst b/Documentation/applications/examples/bmp280/index.rst
@@ -1,3 +1,4 @@
+==========================================
 ``bmp280`` BMP280 Barometer sensor example
 ==========================================
 

diff --git a/Documentation/applications/examples/bridge/index.rst b/Documentation/applications/examples/bridge/index.rst
@@ -1,3 +1,4 @@
+=========================
 ``bridge`` Network Bridge
 =========================
 

diff --git a/Documentation/applications/examples/buttons/index.rst b/Documentation/applications/examples/buttons/index.rst
@@ -1,3 +1,4 @@
+=============================
 ``buttons`` Read GPIO Buttons
 =============================
 

diff --git a/Documentation/applications/examples/calib_udelay/index.rst b/Documentation/applications/examples/calib_udelay/index.rst
@@ -1,3 +1,4 @@
+=============================================
 ``calib_udelay`` Calibration tool for udelay
 =============================================
 

diff --git a/Documentation/applications/examples/camera/index.rst b/Documentation/applications/examples/camera/index.rst
@@ -1,3 +1,4 @@
+==========================
 ``camera`` Camera Snapshot
 ==========================
 

diff --git a/Documentation/applications/examples/can/index.rst b/Documentation/applications/examples/can/index.rst
@@ -1,3 +1,4 @@
+=======================
 ``can`` CAN Device Test
 =======================
 

diff --git a/Documentation/applications/examples/capture/index.rst b/Documentation/applications/examples/capture/index.rst
@@ -1,3 +1,4 @@
+===============================
 ``capture`` PWM Capture example
 ===============================
 

diff --git a/Documentation/applications/examples/cbortest/index.rst b/Documentation/applications/examples/cbortest/index.rst
@@ -1,3 +1,4 @@
+==================================
 ``cbortest`` TinyCBOR Test Example
 ==================================
 

diff --git a/Documentation/applications/examples/cctype/index.rst b/Documentation/applications/examples/cctype/index.rst
@@ -1,3 +1,4 @@
+=======================================
 ``cctype`` Verify C++ cctype operations
 =======================================
 

diff --git a/Documentation/applications/examples/chat/index.rst b/Documentation/applications/examples/chat/index.rst
@@ -1,3 +1,4 @@
+====================
 ``chat`` AT over TTY
 ====================
 

diff --git a/Documentation/applications/examples/chrono/index.rst b/Documentation/applications/examples/chrono/index.rst
@@ -1,3 +1,4 @@
+=========================================================
 ``chrono`` Chronometer example to use with STM32LDiscover
 =========================================================
 

diff --git a/Documentation/applications/examples/configdata/index.rst b/Documentation/applications/examples/configdata/index.rst
@@ -1,3 +1,4 @@
+==============================================
 ``configdata`` Config Data example / unit test
 ==============================================
 

diff --git a/Documentation/applications/examples/cordic/index.rst b/Documentation/applications/examples/cordic/index.rst
@@ -1,3 +1,4 @@
+================================
 ``cordic`` CORDIC driver example
 ================================
 

diff --git a/Documentation/applications/examples/cpuhog/index.rst b/Documentation/applications/examples/cpuhog/index.rst
@@ -1,3 +1,4 @@
+========================
 ``cpuhog`` Keep CPU Busy
 ========================
 

diff --git a/Documentation/applications/examples/cromfs/index.rst b/Documentation/applications/examples/cromfs/index.rst
@@ -1,3 +1,4 @@
+=========================
 ``cromfs`` CROMFS Example
 =========================
 

diff --git a/Documentation/applications/examples/dac/index.rst b/Documentation/applications/examples/dac/index.rst
@@ -1,3 +1,4 @@
+====================
 ``dac`` Write to DAC
 ====================
 

diff --git a/Documentation/applications/examples/dhcpd/index.rst b/Documentation/applications/examples/dhcpd/index.rst
@@ -1,3 +1,4 @@
+=====================
 ``dhcpd`` DHCP Server
 =====================
 

diff --git a/Documentation/applications/examples/discover/index.rst b/Documentation/applications/examples/discover/index.rst
@@ -1,3 +1,4 @@
+================================
 ``discover`` UDP Discover Daemon
 ================================
 

diff --git a/Documentation/applications/examples/djoystick/index.rst b/Documentation/applications/examples/djoystick/index.rst
@@ -1,3 +1,4 @@
+===============================
 ``djoystick`` Discrete Joystick
 ===============================
 

diff --git a/Documentation/applications/examples/dronecan/index.rst b/Documentation/applications/examples/dronecan/index.rst
@@ -1,3 +1,4 @@
+=============================
 ``dronecan`` DroneCAN example
 =============================
 

diff --git a/Documentation/applications/examples/elf/index.rst b/Documentation/applications/examples/elf/index.rst
@@ -1,3 +1,4 @@
+==================
 ``elf`` ELF loader
 ==================
 

diff --git a/Documentation/applications/examples/embedlog/index.rst b/Documentation/applications/examples/embedlog/index.rst
@@ -1,3 +1,4 @@
+=============================
 ``embedlog`` embedlog example
 =============================
 

diff --git a/Documentation/applications/examples/esp32_himem/index.rst b/Documentation/applications/examples/esp32_himem/index.rst
@@ -1,3 +1,4 @@
+===================================
 ``esp32_himem`` ESP32 HIMEM Example
 ===================================
 

diff --git a/Documentation/applications/examples/etl/index.rst b/Documentation/applications/examples/etl/index.rst
@@ -1,3 +1,4 @@
+===================================================
 ``etl`` Embedded Template Library (ETL) C++ example
 ===================================================
 

diff --git a/Documentation/applications/examples/fb/index.rst b/Documentation/applications/examples/fb/index.rst
@@ -1,3 +1,4 @@
+==================
 ``fb`` Framebuffer
 ==================
 

diff --git a/Documentation/applications/examples/fboverlay/index.rst b/Documentation/applications/examples/fboverlay/index.rst
@@ -1,3 +1,4 @@
+===========================================
 ``fboverlay`` Framebuffer overlay test tool
 ===========================================
 

diff --git a/Documentation/applications/examples/flash_test/index.rst b/Documentation/applications/examples/flash_test/index.rst
@@ -1,3 +1,4 @@
+===============================
 ``flash_test`` SMART Flash test
 ===============================
 

diff --git a/Documentation/applications/examples/flowc/index.rst b/Documentation/applications/examples/flowc/index.rst
@@ -1,3 +1,4 @@
+======================================
 ``flowc`` Serial Hardware Flow Control
 ======================================
 

diff --git a/Documentation/applications/examples/fmsynth/index.rst b/Documentation/applications/examples/fmsynth/index.rst
@@ -1,3 +1,4 @@
+===================================
 ``fmsynth`` FM Synthesizer examples
 ===================================
 

diff --git a/Documentation/applications/examples/foc/index.rst b/Documentation/applications/examples/foc/index.rst
@@ -1,3 +1,4 @@
+====================================
 ``foc`` FOC motor controller example
 ====================================
 

diff --git a/Documentation/applications/examples/ft80x/index.rst b/Documentation/applications/examples/ft80x/index.rst
@@ -1,3 +1,4 @@
+========================
 ``ft80x`` FT80x GUI Chip
 ========================
 

diff --git a/Documentation/applications/examples/ftpc/index.rst b/Documentation/applications/examples/ftpc/index.rst
@@ -1,3 +1,4 @@
+===================
 ``ftpc`` FTP Client
 ===================
 

diff --git a/Documentation/applications/examples/ftpd/index.rst b/Documentation/applications/examples/ftpd/index.rst
@@ -1,3 +1,4 @@
+===================
 ``ftpd`` FTP daemon
 ===================
 

diff --git a/Documentation/applications/examples/fxos8700cq_test/index.rst b/Documentation/applications/examples/fxos8700cq_test/index.rst
@@ -1,3 +1,4 @@
+===================
 ``fxos8700cq_test``
 ===================
 

diff --git a/Documentation/applications/examples/gpio/index.rst b/Documentation/applications/examples/gpio/index.rst
@@ -1,4 +1,5 @@
+============================
 ``gpio`` GPIO Read and Write
-----------------------------
+============================
 
 A simple ``test/example`` of the NuttX GPIO driver.
diff --git a/Documentation/applications/examples/gps/index.rst b/Documentation/applications/examples/gps/index.rst
@@ -1,3 +1,4 @@
+===================
 ``gps`` GPS example
 ===================
 

diff --git a/Documentation/applications/examples/hall/index.rst b/Documentation/applications/examples/hall/index.rst
@@ -1,3 +1,4 @@
+===================================
 ``hall`` Hall effect sensor example
 ===================================
 

diff --git a/Documentation/applications/examples/hdc1008_demo/index.rst b/Documentation/applications/examples/hdc1008_demo/index.rst
@@ -1,3 +1,4 @@
+=======================================
 ``hdc1008_demo`` HDC1008 driver example
 =======================================
 

diff --git a/Documentation/applications/examples/hello/index.rst b/Documentation/applications/examples/hello/index.rst
@@ -1,3 +1,4 @@
+=====================
 ``hello`` Hello World
 =====================
 

diff --git a/Documentation/applications/examples/hello_nim/index.rst b/Documentation/applications/examples/hello_nim/index.rst
@@ -1,3 +1,4 @@
+================================
 ``hello_nim`` Hello World in Nim
 ================================
 

diff --git a/Documentation/applications/examples/hello_rust/index.rst b/Documentation/applications/examples/hello_rust/index.rst
@@ -1,3 +1,4 @@
+==================================
 ``hello_rust`` Hello World in Rust
 ==================================
 

diff --git a/Documentation/applications/examples/hello_wasm/index.rst b/Documentation/applications/examples/hello_wasm/index.rst
@@ -1,3 +1,4 @@
+==================================
 ``hello_wasm`` Hello World in WASM
 ==================================
 

diff --git a/Documentation/applications/examples/hello_zig/index.rst b/Documentation/applications/examples/hello_zig/index.rst
@@ -1,3 +1,4 @@
+================================
 ``hello_zig`` Hello World in Zig
 ================================
 

diff --git a/Documentation/applications/examples/helloxx/index.rst b/Documentation/applications/examples/helloxx/index.rst
@@ -1,3 +1,4 @@
+==============================
 ``helloxx`` Hello World in C++
 ==============================
 

diff --git a/Documentation/applications/examples/hidkbd/index.rst b/Documentation/applications/examples/hidkbd/index.rst
@@ -1,3 +1,4 @@
+================================
 ``hidkbd`` USB Host HID keyboard
 ================================
 

diff --git a/Documentation/applications/examples/hts221_reader/index.rst b/Documentation/applications/examples/hts221_reader/index.rst
@@ -1,3 +1,4 @@
+============================================
 ``hts221_reader`` ``HTS221`` Humidity Sensor
 ============================================
 

diff --git a/Documentation/applications/examples/i2cchar/index.rst b/Documentation/applications/examples/i2cchar/index.rst
@@ -1,3 +1,4 @@
+================================
 ``i2cchar`` Transfer Through I2C
 ================================
 

diff --git a/Documentation/applications/examples/i2sloop/index.rst b/Documentation/applications/examples/i2sloop/index.rst
@@ -1,3 +1,4 @@
+=============================
 ``i2sloop`` I2S loopback test
 =============================
 

diff --git a/Documentation/applications/examples/igmp/index.rst b/Documentation/applications/examples/igmp/index.rst
@@ -1,3 +1,4 @@
+=====================
 ``igmp`` Trivial IGMP
 =====================
 

diff --git a/Documentation/applications/examples/ina219/index.rst b/Documentation/applications/examples/ina219/index.rst
@@ -1,3 +1,4 @@
+=======================================
 ``ina219`` Current/Power Monitor INA219
 =======================================
 

diff --git a/Documentation/applications/examples/ina226/index.rst b/Documentation/applications/examples/ina226/index.rst
@@ -1,4 +1,5 @@
+=======================================
 ``ina226`` Current/Power Monitor INA219
-======================================
+=======================================
 
 TODO
diff --git a/Documentation/applications/examples/index.rst b/Documentation/applications/examples/index.rst
@@ -1,3 +1,4 @@
+========
 Examples
 ========
 

diff --git a/Documentation/applications/examples/ini_dumper/index.rst b/Documentation/applications/examples/ini_dumper/index.rst
@@ -1,3 +1,4 @@
+=================================
 ``ini_dumper`` ini dumper example
 =================================
 

diff --git a/Documentation/applications/examples/ipcfg/index.rst b/Documentation/applications/examples/ipcfg/index.rst
@@ -1,3 +1,4 @@
+=======================================
 ``ipcfg`` IP Configuration file example
 =======================================
 

diff --git a/Documentation/applications/examples/json/index.rst b/Documentation/applications/examples/json/index.rst
@@ -1,3 +1,4 @@
+==============
 ``json`` cJSON
 ==============
 

diff --git a/Documentation/applications/examples/keyboard/index.rst b/Documentation/applications/examples/keyboard/index.rst
@@ -1,3 +1,4 @@
+============
 ``keyboard``
 ============
 

diff --git a/Documentation/applications/examples/leds/index.rst b/Documentation/applications/examples/leds/index.rst
@@ -1,3 +1,4 @@
+====================
 ``leds`` Toggle LEDs
 ====================
 

diff --git a/Documentation/applications/examples/libtest/index.rst b/Documentation/applications/examples/libtest/index.rst
@@ -1,3 +1,4 @@
+===============================
 ``libtest`` Static Library Test
 ===============================
 

diff --git a/Documentation/applications/examples/lis3dsh_reader/index.rst b/Documentation/applications/examples/lis3dsh_reader/index.rst
@@ -1,3 +1,4 @@
+============================================
 ``lis3dsh_reader`` ``LIS3DSH`` Accelerometer
 ============================================
 

diff --git a/Documentation/applications/examples/lp503x/index.rst b/Documentation/applications/examples/lp503x/index.rst
@@ -1,4 +1,5 @@
+=================================
 ``lp503x`` LP503X PWM LED example
-================================
+=================================
 
 TODO
diff --git a/Documentation/applications/examples/lsm303_reader/index.rst b/Documentation/applications/examples/lsm303_reader/index.rst
@@ -1,3 +1,4 @@
+=======================================================
 ``lsm303_reader`` ``LSM303`` Accelerometer/Magnetometer
 =======================================================
 

diff --git a/Documentation/applications/examples/lsm6dsl_reader/index.rst b/Documentation/applications/examples/lsm6dsl_reader/index.rst
@@ -1,3 +1,4 @@
+======================================================
 ``lsm6dsl_reader`` ``LSM6DSL`` Accelerometer/Gyroscope
 ======================================================
 

diff --git a/Documentation/applications/examples/ltr308/index.rst b/Documentation/applications/examples/ltr308/index.rst
@@ -1,3 +1,4 @@
+==============================================
 ``ltr308`` LTR308 ambient light sensor example
 ==============================================
 

diff --git a/Documentation/applications/examples/lua_module/index.rst b/Documentation/applications/examples/lua_module/index.rst
@@ -1,3 +1,4 @@
+=====================================
 ``lua_module`` Hello World Lua module
 =====================================