From 731eaefba2542143abb0c06f3b508e126433eb83 Mon Sep 17 00:00:00 2001 From: raiden00pl Date: Mon, 23 Oct 2023 18:58:34 +0200 Subject: [PATCH] Documentation/examples: add missing titles --- Documentation/applications/examples/ina226/index.rst | 4 ++-- Documentation/applications/examples/ini_dumper/index.rst | 4 ++-- Documentation/applications/examples/ipcfg/index.rst | 4 ++-- Documentation/applications/examples/lp503x/index.rst | 4 ++-- Documentation/applications/examples/ltr308/index.rst | 4 ++-- Documentation/applications/examples/lvgldemo/index.rst | 4 ++-- Documentation/applications/examples/max31855/index.rst | 4 ++-- Documentation/applications/examples/mcuboot/index.rst | 4 ++-- Documentation/applications/examples/media/index.rst | 4 ++-- Documentation/applications/examples/mld/index.rst | 4 ++-- Documentation/applications/examples/mlx90614/index.rst | 4 ++-- Documentation/applications/examples/mml_parser/index.rst | 4 ++-- Documentation/applications/examples/modbus/index.rst | 4 ++-- Documentation/applications/examples/modbusmaster/index.rst | 4 ++-- Documentation/applications/examples/mqttc/index.rst | 4 ++-- Documentation/applications/examples/netlink_route/index.rst | 4 ++-- Documentation/applications/examples/nimble/index.rst | 4 ++-- Documentation/applications/examples/nng_test/index.rst | 4 ++-- Documentation/applications/examples/noteprintf/index.rst | 4 ++-- Documentation/applications/examples/nrf24l01_btle/index.rst | 4 ++-- Documentation/applications/examples/null/index.rst | 4 ++-- Documentation/applications/examples/nx/index.rst | 4 ++-- Documentation/applications/examples/nxdemo/index.rst | 4 ++-- Documentation/applications/examples/nxhello/index.rst | 4 ++-- Documentation/applications/examples/nxscope/index.rst | 4 ++-- Documentation/applications/examples/obd2/index.rst | 4 ++-- Documentation/applications/examples/opencyphal/index.rst | 4 ++-- Documentation/applications/examples/pdcurses/index.rst | 4 ++-- Documentation/applications/examples/pf_ieee802154/index.rst | 4 ++-- Documentation/applications/examples/pipe/index.rst | 4 ++-- Documentation/applications/examples/poll/index.rst | 4 ++-- Documentation/applications/examples/popen/index.rst | 4 ++-- Documentation/applications/examples/posix_spawn/index.rst | 4 ++-- Documentation/applications/examples/powerled/index.rst | 4 ++-- Documentation/applications/examples/pppd/index.rst | 4 ++-- Documentation/applications/examples/pwfb/index.rst | 4 ++-- Documentation/applications/examples/pwlines/index.rst | 4 ++-- Documentation/applications/examples/rpmsgsocket/index.rst | 4 ++-- Documentation/applications/examples/serialblaster/index.rst | 4 ++-- Documentation/applications/examples/serialrx/index.rst | 4 ++-- Documentation/applications/examples/shm_test/index.rst | 4 ++-- Documentation/applications/examples/sht3x/index.rst | 4 ++-- Documentation/applications/examples/stat/index.rst | 4 ++-- Documentation/applications/examples/sx127x_demo/index.rst | 4 ++-- Documentation/applications/examples/system/index.rst | 4 ++-- Documentation/applications/examples/tcp_ipc_client/index.rst | 4 ++-- Documentation/applications/examples/tcp_ipc_server/index.rst | 4 ++-- Documentation/applications/examples/tiff/index.rst | 4 ++-- Documentation/applications/examples/timer/index.rst | 4 ++-- Documentation/applications/examples/timer_gpio/index.rst | 4 ++-- Documentation/applications/examples/udgram/index.rst | 4 ++-- Documentation/applications/examples/udpblaster/index.rst | 4 ++-- Documentation/applications/examples/uid/index.rst | 4 ++-- Documentation/applications/examples/usrsocktest/index.rst | 4 ++-- Documentation/applications/examples/veml6070/index.rst | 4 ++-- Documentation/applications/examples/wiegand/index.rst | 4 ++-- Documentation/applications/examples/ws2812/index.rst | 4 ++-- Documentation/applications/examples/ws2812esp32rmt/index.rst | 4 ++-- Documentation/applications/examples/xbc_test/index.rst | 4 ++-- 59 files changed, 118 insertions(+), 118 deletions(-) diff --git a/Documentation/applications/examples/ina226/index.rst b/Documentation/applications/examples/ina226/index.rst index fea20e31d0..dff8c9a004 100644 --- a/Documentation/applications/examples/ina226/index.rst +++ b/Documentation/applications/examples/ina226/index.rst @@ -1,4 +1,4 @@ -``ina226`` -========== +``ina226`` Current/Power Monitor INA219 +====================================== TODO diff --git a/Documentation/applications/examples/ini_dumper/index.rst b/Documentation/applications/examples/ini_dumper/index.rst index 0320eb02e9..333534d4b7 100644 --- a/Documentation/applications/examples/ini_dumper/index.rst +++ b/Documentation/applications/examples/ini_dumper/index.rst @@ -1,4 +1,4 @@ -``ini_dumper`` -============== +``ini_dumper`` ini dumper example +================================= TODO diff --git a/Documentation/applications/examples/ipcfg/index.rst b/Documentation/applications/examples/ipcfg/index.rst index c6d3dcd705..daffe8ebef 100644 --- a/Documentation/applications/examples/ipcfg/index.rst +++ b/Documentation/applications/examples/ipcfg/index.rst @@ -1,4 +1,4 @@ -``ipcfg`` -========= +``ipcfg`` IP Configuration file example +======================================= TODO diff --git a/Documentation/applications/examples/lp503x/index.rst b/Documentation/applications/examples/lp503x/index.rst index 64da9b69c0..3a22466199 100644 --- a/Documentation/applications/examples/lp503x/index.rst +++ b/Documentation/applications/examples/lp503x/index.rst @@ -1,4 +1,4 @@ -``lp503x`` -=========== +``lp503x`` LP503X PWM LED example +================================ TODO diff --git a/Documentation/applications/examples/ltr308/index.rst b/Documentation/applications/examples/ltr308/index.rst index ef372e0d6f..035dc49b75 100644 --- a/Documentation/applications/examples/ltr308/index.rst +++ b/Documentation/applications/examples/ltr308/index.rst @@ -1,4 +1,4 @@ -``ltr308`` -=========== +``ltr308`` LTR308 ambient light sensor example +============================================== TODO diff --git a/Documentation/applications/examples/lvgldemo/index.rst b/Documentation/applications/examples/lvgldemo/index.rst index c202e55125..176c2286ec 100644 --- a/Documentation/applications/examples/lvgldemo/index.rst +++ b/Documentation/applications/examples/lvgldemo/index.rst @@ -1,4 +1,4 @@ -``lvgldemo`` -============ +``lvgldemo`` LVGL Demo +===================== TODO diff --git a/Documentation/applications/examples/max31855/index.rst b/Documentation/applications/examples/max31855/index.rst index ecf20d814b..93e7b67b43 100644 --- a/Documentation/applications/examples/max31855/index.rst +++ b/Documentation/applications/examples/max31855/index.rst @@ -1,4 +1,4 @@ -``max31855`` -============ +``max31855`` max31855 example +============================= TODO diff --git a/Documentation/applications/examples/mcuboot/index.rst b/Documentation/applications/examples/mcuboot/index.rst index 087144e1f8..2b7176c34c 100644 --- a/Documentation/applications/examples/mcuboot/index.rst +++ b/Documentation/applications/examples/mcuboot/index.rst @@ -1,5 +1,5 @@ -``mcuboot`` -=========== +``mcuboot`` MCUboot examples +============================ ``swap_test`` ------------- diff --git a/Documentation/applications/examples/media/index.rst b/Documentation/applications/examples/media/index.rst index d85522a0c9..66aa17a689 100644 --- a/Documentation/applications/examples/media/index.rst +++ b/Documentation/applications/examples/media/index.rst @@ -1,5 +1,5 @@ -``media`` -========= +``media`` Media test +==================== The media test simply writes values onto the media hidden behind a character driver and verifies that the media can be successfully written and read. This diff --git a/Documentation/applications/examples/mld/index.rst b/Documentation/applications/examples/mld/index.rst index 6718f8d9a0..48dde4eab1 100644 --- a/Documentation/applications/examples/mld/index.rst +++ b/Documentation/applications/examples/mld/index.rst @@ -1,4 +1,4 @@ -``mld`` -======= +``mld`` MLD example +================== TODO diff --git a/Documentation/applications/examples/mlx90614/index.rst b/Documentation/applications/examples/mlx90614/index.rst index ee5ff86500..c568e52df8 100644 --- a/Documentation/applications/examples/mlx90614/index.rst +++ b/Documentation/applications/examples/mlx90614/index.rst @@ -1,4 +1,4 @@ -``mlx90614`` -============ +``mlx90614`` MLX90614 Test Example +================================== TODO diff --git a/Documentation/applications/examples/mml_parser/index.rst b/Documentation/applications/examples/mml_parser/index.rst index db9041df77..24bac56598 100644 --- a/Documentation/applications/examples/mml_parser/index.rst +++ b/Documentation/applications/examples/mml_parser/index.rst @@ -1,4 +1,4 @@ -``mml_parser`` -============== +``mml_parser`` MML parser example +================================= TODO diff --git a/Documentation/applications/examples/modbus/index.rst b/Documentation/applications/examples/modbus/index.rst index fef63bc10d..cd436cefe8 100644 --- a/Documentation/applications/examples/modbus/index.rst +++ b/Documentation/applications/examples/modbus/index.rst @@ -1,5 +1,5 @@ -``modbus`` FreeModbus -===================== +``modbus`` FreeModbus demo example +================================== This is a port of the FreeModbus Linux demo. It derives from the demos/LINUX directory of the FreeModBus version ``1.5.0`` (June 6, 2010) that can be diff --git a/Documentation/applications/examples/modbusmaster/index.rst b/Documentation/applications/examples/modbusmaster/index.rst index f7d573dcaa..87e65f6561 100644 --- a/Documentation/applications/examples/modbusmaster/index.rst +++ b/Documentation/applications/examples/modbusmaster/index.rst @@ -1,4 +1,4 @@ -``modbusmaster`` -================ +``modbusmaster`` Modbus Master example +====================================== TODO diff --git a/Documentation/applications/examples/mqttc/index.rst b/Documentation/applications/examples/mqttc/index.rst index e33eadc75b..c411ffabe1 100644 --- a/Documentation/applications/examples/mqttc/index.rst +++ b/Documentation/applications/examples/mqttc/index.rst @@ -1,5 +1,5 @@ -``mqttc`` -========= +``mqttc`` MQTT-C Example +======================== This is a simple MQTT publisher example using MQTT-C diff --git a/Documentation/applications/examples/netlink_route/index.rst b/Documentation/applications/examples/netlink_route/index.rst index 1a6ffff4b3..3ec0219e93 100644 --- a/Documentation/applications/examples/netlink_route/index.rst +++ b/Documentation/applications/examples/netlink_route/index.rst @@ -1,4 +1,4 @@ -``netlink_route`` -================= +``netlink_route`` Netlink NETLINK_ROUTE test +============================================ TODO diff --git a/Documentation/applications/examples/nimble/index.rst b/Documentation/applications/examples/nimble/index.rst index 65ef4e7758..d24a18b4e7 100644 --- a/Documentation/applications/examples/nimble/index.rst +++ b/Documentation/applications/examples/nimble/index.rst @@ -1,4 +1,4 @@ -``nimble`` -========== +``nimble`` NimBLE example +========================= TODO diff --git a/Documentation/applications/examples/nng_test/index.rst b/Documentation/applications/examples/nng_test/index.rst index 567fbf1253..244089f0c9 100644 --- a/Documentation/applications/examples/nng_test/index.rst +++ b/Documentation/applications/examples/nng_test/index.rst @@ -1,4 +1,4 @@ -``nng_test`` -============ +``nng_test`` NNG pubsub program +=============================== TODO diff --git a/Documentation/applications/examples/noteprintf/index.rst b/Documentation/applications/examples/noteprintf/index.rst index bb20f177ee..4df7eb8238 100644 --- a/Documentation/applications/examples/noteprintf/index.rst +++ b/Documentation/applications/examples/noteprintf/index.rst @@ -1,4 +1,4 @@ -``noteprintf`` -============== +``noteprintf`` "Note printf!" example +===================================== TODO diff --git a/Documentation/applications/examples/nrf24l01_btle/index.rst b/Documentation/applications/examples/nrf24l01_btle/index.rst index 475d5e0a8a..302115c46c 100644 --- a/Documentation/applications/examples/nrf24l01_btle/index.rst +++ b/Documentation/applications/examples/nrf24l01_btle/index.rst @@ -1,4 +1,4 @@ -``nrf24l01_btle`` -================= +``nrf24l01_btle`` Emulates a nRF8001 temperature beacon with nRF24L01 +===================================================================== TODO diff --git a/Documentation/applications/examples/null/index.rst b/Documentation/applications/examples/null/index.rst index 0eefcebeaf..6cd0880bc5 100644 --- a/Documentation/applications/examples/null/index.rst +++ b/Documentation/applications/examples/null/index.rst @@ -1,5 +1,5 @@ -``null`` -======== +``null`` NULL example +===================== This is the do nothing application. It is only used for bringing up new NuttX architectures in the most minimal of environments. diff --git a/Documentation/applications/examples/nx/index.rst b/Documentation/applications/examples/nx/index.rst index a561cf9de3..e5b8dff3c0 100644 --- a/Documentation/applications/examples/nx/index.rst +++ b/Documentation/applications/examples/nx/index.rst @@ -1,5 +1,5 @@ -``nx`` -====== +``nx`` NX graphics example +========================== This directory contains a simple test of a subset of the NX APIs defined in ``include/nuttx/nx/nx.h``. The following configuration options can be selected: diff --git a/Documentation/applications/examples/nxdemo/index.rst b/Documentation/applications/examples/nxdemo/index.rst index c3cf6352e7..bc18d203bb 100644 --- a/Documentation/applications/examples/nxdemo/index.rst +++ b/Documentation/applications/examples/nxdemo/index.rst @@ -1,4 +1,4 @@ -``nxdemo`` -========== +``nxdemo`` NX Demo "Graphic test" example +========================================= TODO diff --git a/Documentation/applications/examples/nxhello/index.rst b/Documentation/applications/examples/nxhello/index.rst index 152da5c96f..fc85ab8f0f 100644 --- a/Documentation/applications/examples/nxhello/index.rst +++ b/Documentation/applications/examples/nxhello/index.rst @@ -1,5 +1,5 @@ -``nxhello`` -=========== +``nxhello`` NX graphics "Hello, World!" example +=============================================== A very simple graphics example that just says Hello, World! in the center of the display. diff --git a/Documentation/applications/examples/nxscope/index.rst b/Documentation/applications/examples/nxscope/index.rst index cd6fc11dd8..9aef08145a 100644 --- a/Documentation/applications/examples/nxscope/index.rst +++ b/Documentation/applications/examples/nxscope/index.rst @@ -1,4 +1,4 @@ -``nxscope`` -=========== +``nxscope`` NxScope library example +=================================== TODO diff --git a/Documentation/applications/examples/obd2/index.rst b/Documentation/applications/examples/obd2/index.rst index 4c5c7e6a6f..58ed454276 100644 --- a/Documentation/applications/examples/obd2/index.rst +++ b/Documentation/applications/examples/obd2/index.rst @@ -1,4 +1,4 @@ -``obd2`` -======== +``obd2`` OBD-II application example +=================================== A simple test of ``apps/canutils/libobd2``. diff --git a/Documentation/applications/examples/opencyphal/index.rst b/Documentation/applications/examples/opencyphal/index.rst index 465c11b464..d907954525 100644 --- a/Documentation/applications/examples/opencyphal/index.rst +++ b/Documentation/applications/examples/opencyphal/index.rst @@ -1,4 +1,4 @@ -``opencyphal`` -============== +``opencyphal`` OpenCyphal Cyphal/CAN example +============================================ TODO diff --git a/Documentation/applications/examples/pdcurses/index.rst b/Documentation/applications/examples/pdcurses/index.rst index 9ceb8801a0..d71ab91282 100644 --- a/Documentation/applications/examples/pdcurses/index.rst +++ b/Documentation/applications/examples/pdcurses/index.rst @@ -1,5 +1,5 @@ -``pdcurses`` -============ +``pdcurses`` pdcurses demos +=========================== This directory contains demonstration programs to show and test the capabilities of ``pdcurses`` libraries. Some of them predate PDCurses, PCcurses or even diff --git a/Documentation/applications/examples/pf_ieee802154/index.rst b/Documentation/applications/examples/pf_ieee802154/index.rst index a097706fe3..0bd0d8d656 100644 --- a/Documentation/applications/examples/pf_ieee802154/index.rst +++ b/Documentation/applications/examples/pf_ieee802154/index.rst @@ -1,4 +1,4 @@ -``pf_ieee802154`` -================= +``pf_ieee802154`` PF_IEEE802154 example +====================================== TODO diff --git a/Documentation/applications/examples/pipe/index.rst b/Documentation/applications/examples/pipe/index.rst index f65f2c914e..ab1af3dae1 100644 --- a/Documentation/applications/examples/pipe/index.rst +++ b/Documentation/applications/examples/pipe/index.rst @@ -1,5 +1,5 @@ -``pipe`` -======== +``pipe`` Pipe example +===================== A test of the ``mkfifo()`` and ``pipe()`` APIs. Requires ``CONFIG_PIPES`` diff --git a/Documentation/applications/examples/poll/index.rst b/Documentation/applications/examples/poll/index.rst index 96c87898fc..f277e6dd6f 100644 --- a/Documentation/applications/examples/poll/index.rst +++ b/Documentation/applications/examples/poll/index.rst @@ -1,5 +1,5 @@ -``poll`` -======== +``poll`` Poll example +===================== A test of the ``poll()`` and ``select()`` APIs using FIFOs and, if available, ``stdin``, and a TCP/IP socket. In order to use the TCP/IP select test, you must diff --git a/Documentation/applications/examples/popen/index.rst b/Documentation/applications/examples/popen/index.rst index 5f3ec21aa5..978a1a7642 100644 --- a/Documentation/applications/examples/popen/index.rst +++ b/Documentation/applications/examples/popen/index.rst @@ -1,4 +1,4 @@ -``popen`` -========= +``popen`` popen() example +========================= TODO diff --git a/Documentation/applications/examples/posix_spawn/index.rst b/Documentation/applications/examples/posix_spawn/index.rst index 01288d7eac..57de02a7cc 100644 --- a/Documentation/applications/examples/posix_spawn/index.rst +++ b/Documentation/applications/examples/posix_spawn/index.rst @@ -1,5 +1,5 @@ -``posix_spawn`` -=============== +``posix_spawn`` posix_spawn Unit Test +===================================== This is a simple test of the ``posix_spawn()`` API. The example derives from ``examples/elf``. As a result, these tests are built using the relocatable ELF diff --git a/Documentation/applications/examples/powerled/index.rst b/Documentation/applications/examples/powerled/index.rst index ae55179377..b05f1ec673 100644 --- a/Documentation/applications/examples/powerled/index.rst +++ b/Documentation/applications/examples/powerled/index.rst @@ -1,5 +1,5 @@ -``powerled`` -============ +``powerled`` Powerled driver example +==================================== This is a powerled driver example application. This application support three operation modes which can be selected from NSH command line: diff --git a/Documentation/applications/examples/pppd/index.rst b/Documentation/applications/examples/pppd/index.rst index 306b0e24c7..bcccc75768 100644 --- a/Documentation/applications/examples/pppd/index.rst +++ b/Documentation/applications/examples/pppd/index.rst @@ -1,4 +1,4 @@ -``pppd`` -======== +``pppd`` pppd client example +============================ TODO diff --git a/Documentation/applications/examples/pwfb/index.rst b/Documentation/applications/examples/pwfb/index.rst index 9176065f10..4df0fb80dd 100644 --- a/Documentation/applications/examples/pwfb/index.rst +++ b/Documentation/applications/examples/pwfb/index.rst @@ -1,5 +1,5 @@ -``pwfb`` -======== +``pwfb`` NX Per-Window Framebuffer Text Example +=============================================== A graphics example using pre-window frame buffers. The example shows three windows containing text moving around, crossing each other from above and from diff --git a/Documentation/applications/examples/pwlines/index.rst b/Documentation/applications/examples/pwlines/index.rst index c21547b52f..16ce0b776a 100644 --- a/Documentation/applications/examples/pwlines/index.rst +++ b/Documentation/applications/examples/pwlines/index.rst @@ -1,4 +1,4 @@ -``pwlines`` -=========== +``pwlines`` NX Per-Window Framebuffer Graphics Example +====================================================== TODO diff --git a/Documentation/applications/examples/rpmsgsocket/index.rst b/Documentation/applications/examples/rpmsgsocket/index.rst index 1a5400f3bc..f28707c457 100644 --- a/Documentation/applications/examples/rpmsgsocket/index.rst +++ b/Documentation/applications/examples/rpmsgsocket/index.rst @@ -1,4 +1,4 @@ -``rpmsgsocket`` -=============== +``rpmsgsocket`` Rpmsg socket example +==================================== TODO diff --git a/Documentation/applications/examples/serialblaster/index.rst b/Documentation/applications/examples/serialblaster/index.rst index 67ca1471b9..6b56449538 100644 --- a/Documentation/applications/examples/serialblaster/index.rst +++ b/Documentation/applications/examples/serialblaster/index.rst @@ -1,5 +1,5 @@ -``serialblaster`` -================= +``serialblaster`` Serial Blaster example +======================================== Sends a repeating pattern (the alphabet) out a serial port continuously. This may be useful if you are trying run down other problems that you think might diff --git a/Documentation/applications/examples/serialrx/index.rst b/Documentation/applications/examples/serialrx/index.rst index 1592e1b545..a7eb9bf823 100644 --- a/Documentation/applications/examples/serialrx/index.rst +++ b/Documentation/applications/examples/serialrx/index.rst @@ -1,5 +1,5 @@ -``serialrx`` -============ +``serialrx`` Serial RX example +============================== Constant receives serial data. This is the complement to ``serialblaster``. This may be useful if you are trying run down other problems that you think might diff --git a/Documentation/applications/examples/shm_test/index.rst b/Documentation/applications/examples/shm_test/index.rst index fedfb0f2d1..3ca80dc791 100644 --- a/Documentation/applications/examples/shm_test/index.rst +++ b/Documentation/applications/examples/shm_test/index.rst @@ -1,4 +1,4 @@ -``shm_test`` -============ +``shm_test`` SHM example +======================== TODO diff --git a/Documentation/applications/examples/sht3x/index.rst b/Documentation/applications/examples/sht3x/index.rst index c7932e5d6c..96a6d087a2 100644 --- a/Documentation/applications/examples/sht3x/index.rst +++ b/Documentation/applications/examples/sht3x/index.rst @@ -1,4 +1,4 @@ -``sht3x`` -========= +``sht3x`` SHT3x sensor example +============================== TODO diff --git a/Documentation/applications/examples/stat/index.rst b/Documentation/applications/examples/stat/index.rst index 053a43b803..94f64fd30a 100644 --- a/Documentation/applications/examples/stat/index.rst +++ b/Documentation/applications/examples/stat/index.rst @@ -1,5 +1,5 @@ -``stat`` -======== +``stat`` Test of stat(), fstat(), and statfs() +============================================== A simple test of ``stat()``, ``fstat()``, and ``statfs()``. This is useful primarily for bringing up a new file system and verifying the correctness of these diff --git a/Documentation/applications/examples/sx127x_demo/index.rst b/Documentation/applications/examples/sx127x_demo/index.rst index fc4c725793..41b823a0bb 100644 --- a/Documentation/applications/examples/sx127x_demo/index.rst +++ b/Documentation/applications/examples/sx127x_demo/index.rst @@ -1,4 +1,4 @@ -``sx127x_demo`` ``SX127X`` Radio -================================ +``sx127x_demo`` SX127X Radio +============================ This example demonstrates the use of the ``SX127X`` radio. diff --git a/Documentation/applications/examples/system/index.rst b/Documentation/applications/examples/system/index.rst index 6b3ffaf2ff..da84bb2ba1 100644 --- a/Documentation/applications/examples/system/index.rst +++ b/Documentation/applications/examples/system/index.rst @@ -1,5 +1,5 @@ -``system`` -========== +``system`` System() example +=========================== This is a simple test of the ``system()`` command. The test simply executes this ``system`` command: diff --git a/Documentation/applications/examples/tcp_ipc_client/index.rst b/Documentation/applications/examples/tcp_ipc_client/index.rst index f70d0f62bf..13e285ef52 100644 --- a/Documentation/applications/examples/tcp_ipc_client/index.rst +++ b/Documentation/applications/examples/tcp_ipc_client/index.rst @@ -1,5 +1,5 @@ -``tcp_ipc_client`` -================== +``tcp_ipc_client`` Client for TCP IPC NuttX +=========================================== What's this? ------------ diff --git a/Documentation/applications/examples/tcp_ipc_server/index.rst b/Documentation/applications/examples/tcp_ipc_server/index.rst index b176e5546e..f4eb0c42a2 100644 --- a/Documentation/applications/examples/tcp_ipc_server/index.rst +++ b/Documentation/applications/examples/tcp_ipc_server/index.rst @@ -1,5 +1,5 @@ -``tcp_ipc_server`` -================== +``tcp_ipc_server`` Server for TCP IPC NuttX +=========================================== What's this? ------------ diff --git a/Documentation/applications/examples/tiff/index.rst b/Documentation/applications/examples/tiff/index.rst index bad9860f70..26b0eed7e6 100644 --- a/Documentation/applications/examples/tiff/index.rst +++ b/Documentation/applications/examples/tiff/index.rst @@ -1,5 +1,5 @@ -``tiff`` -======== +``tiff`` TIFF file generation example +===================================== This is a simple unit test for the TIFF creation library at ``apps/graphic/tiff``. It is configured to work in the Linux user-mode simulation and has not been diff --git a/Documentation/applications/examples/timer/index.rst b/Documentation/applications/examples/timer/index.rst index ec17e01360..3352a92122 100644 --- a/Documentation/applications/examples/timer/index.rst +++ b/Documentation/applications/examples/timer/index.rst @@ -1,5 +1,5 @@ -``timer`` -========= +``timer`` Timer example +======================= This is a simple test of the timer driver (see ``include/nuttx/timers/timer.h``). diff --git a/Documentation/applications/examples/timer_gpio/index.rst b/Documentation/applications/examples/timer_gpio/index.rst index 30d14b740e..77cb1e2357 100644 --- a/Documentation/applications/examples/timer_gpio/index.rst +++ b/Documentation/applications/examples/timer_gpio/index.rst @@ -1,5 +1,5 @@ -``timer_gpio`` -============== +``timer_gpio`` Timer GPIO example +================================= This example uses the timer interrupt to periodically change the state of a digital output. The digital output may be a relay, a led or anything else. diff --git a/Documentation/applications/examples/udgram/index.rst b/Documentation/applications/examples/udgram/index.rst index 1e3ffe2efb..36326b5493 100644 --- a/Documentation/applications/examples/udgram/index.rst +++ b/Documentation/applications/examples/udgram/index.rst @@ -1,4 +1,4 @@ -``udgram`` -========== +``udgram`` Unix domain datagram example +======================================= TODO diff --git a/Documentation/applications/examples/udpblaster/index.rst b/Documentation/applications/examples/udpblaster/index.rst index 096727a8d5..c7ad4e6edc 100644 --- a/Documentation/applications/examples/udpblaster/index.rst +++ b/Documentation/applications/examples/udpblaster/index.rst @@ -1,5 +1,5 @@ -``udpblaster`` -============== +``udpblaster`` UDP blaster example +================================== This is a simple network test for stressing UDP transfers. It simply sends UDP packets from both the host and the target and the highest possible rate. diff --git a/Documentation/applications/examples/uid/index.rst b/Documentation/applications/examples/uid/index.rst index 43411c2e07..7e44434d31 100644 --- a/Documentation/applications/examples/uid/index.rst +++ b/Documentation/applications/examples/uid/index.rst @@ -1,4 +1,4 @@ -``uid`` -======= +``uid`` UID/GID example +======================= TODO diff --git a/Documentation/applications/examples/usrsocktest/index.rst b/Documentation/applications/examples/usrsocktest/index.rst index da391ad2bb..3b7370087f 100644 --- a/Documentation/applications/examples/usrsocktest/index.rst +++ b/Documentation/applications/examples/usrsocktest/index.rst @@ -1,4 +1,4 @@ -``usrsocktest`` -=============== +``usrsocktest`` USRSOCK test example +=================================== TODO diff --git a/Documentation/applications/examples/veml6070/index.rst b/Documentation/applications/examples/veml6070/index.rst index a6ede63452..6409090d3a 100644 --- a/Documentation/applications/examples/veml6070/index.rst +++ b/Documentation/applications/examples/veml6070/index.rst @@ -1,4 +1,4 @@ -``veml6070`` -============ +``veml6070`` VEML6070 UltraViolet sensor example +================================================ TODO diff --git a/Documentation/applications/examples/wiegand/index.rst b/Documentation/applications/examples/wiegand/index.rst index 3898fdc26a..ee3bdd50ae 100644 --- a/Documentation/applications/examples/wiegand/index.rst +++ b/Documentation/applications/examples/wiegand/index.rst @@ -1,4 +1,4 @@ -``wiegand`` -=========== +``wiegand`` Wiegand example +=========================== TODO diff --git a/Documentation/applications/examples/ws2812/index.rst b/Documentation/applications/examples/ws2812/index.rst index 31b405240b..671c2f8c44 100644 --- a/Documentation/applications/examples/ws2812/index.rst +++ b/Documentation/applications/examples/ws2812/index.rst @@ -1,4 +1,4 @@ -``ws2812`` -========== +``ws2812`` ws2812 Demo +====================== TODO diff --git a/Documentation/applications/examples/ws2812esp32rmt/index.rst b/Documentation/applications/examples/ws2812esp32rmt/index.rst index c49cf21aa7..5e2897c6c8 100644 --- a/Documentation/applications/examples/ws2812esp32rmt/index.rst +++ b/Documentation/applications/examples/ws2812esp32rmt/index.rst @@ -1,4 +1,4 @@ -``ws2812esp32rmt`` -================== +``ws2812esp32rmt`` ws2812 Demo using ESP32_RMT +============================================== TODO diff --git a/Documentation/applications/examples/xbc_test/index.rst b/Documentation/applications/examples/xbc_test/index.rst index eda6232336..4235670f36 100644 --- a/Documentation/applications/examples/xbc_test/index.rst +++ b/Documentation/applications/examples/xbc_test/index.rst @@ -1,4 +1,4 @@ -``xbc_test`` -============ +``xbc_test`` XBox Controller Example +==================================== TODO