Documentation/examples: add missing titles

This commit is contained in:
raiden00pl
2023-10-23 18:58:34 +02:00
committed by Xiang Xiao
parent a342d2a7ac
commit 731eaefba2
59 changed files with 118 additions and 118 deletions
@@ -1,4 +1,4 @@
``ina226`` ``ina226`` Current/Power Monitor INA219
========== ======================================
TODO TODO
@@ -1,4 +1,4 @@
``ini_dumper`` ``ini_dumper`` ini dumper example
============== =================================
TODO TODO
@@ -1,4 +1,4 @@
``ipcfg`` ``ipcfg`` IP Configuration file example
========= =======================================
TODO TODO
@@ -1,4 +1,4 @@
``lp503x`` ``lp503x`` LP503X PWM LED example
=========== ================================
TODO TODO
@@ -1,4 +1,4 @@
``ltr308`` ``ltr308`` LTR308 ambient light sensor example
=========== ==============================================
TODO TODO
@@ -1,4 +1,4 @@
``lvgldemo`` ``lvgldemo`` LVGL Demo
============ =====================
TODO TODO
@@ -1,4 +1,4 @@
``max31855`` ``max31855`` max31855 example
============ =============================
TODO TODO
@@ -1,5 +1,5 @@
``mcuboot`` ``mcuboot`` MCUboot examples
=========== ============================
``swap_test`` ``swap_test``
------------- -------------
@@ -1,5 +1,5 @@
``media`` ``media`` Media test
========= ====================
The media test simply writes values onto the media hidden behind a character 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 driver and verifies that the media can be successfully written and read. This
@@ -1,4 +1,4 @@
``mld`` ``mld`` MLD example
======= ==================
TODO TODO
@@ -1,4 +1,4 @@
``mlx90614`` ``mlx90614`` MLX90614 Test Example
============ ==================================
TODO TODO
@@ -1,4 +1,4 @@
``mml_parser`` ``mml_parser`` MML parser example
============== =================================
TODO TODO
@@ -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 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 directory of the FreeModBus version ``1.5.0`` (June 6, 2010) that can be
@@ -1,4 +1,4 @@
``modbusmaster`` ``modbusmaster`` Modbus Master example
================ ======================================
TODO TODO
@@ -1,5 +1,5 @@
``mqttc`` ``mqttc`` MQTT-C Example
========= ========================
This is a simple MQTT publisher example using MQTT-C This is a simple MQTT publisher example using MQTT-C
@@ -1,4 +1,4 @@
``netlink_route`` ``netlink_route`` Netlink NETLINK_ROUTE test
================= ============================================
TODO TODO
@@ -1,4 +1,4 @@
``nimble`` ``nimble`` NimBLE example
========== =========================
TODO TODO
@@ -1,4 +1,4 @@
``nng_test`` ``nng_test`` NNG pubsub program
============ ===============================
TODO TODO
@@ -1,4 +1,4 @@
``noteprintf`` ``noteprintf`` "Note printf!" example
============== =====================================
TODO TODO
@@ -1,4 +1,4 @@
``nrf24l01_btle`` ``nrf24l01_btle`` Emulates a nRF8001 temperature beacon with nRF24L01
================= =====================================================================
TODO TODO
@@ -1,5 +1,5 @@
``null`` ``null`` NULL example
======== =====================
This is the do nothing application. It is only used for bringing up new NuttX This is the do nothing application. It is only used for bringing up new NuttX
architectures in the most minimal of environments. architectures in the most minimal of environments.
@@ -1,5 +1,5 @@
``nx`` ``nx`` NX graphics example
====== ==========================
This directory contains a simple test of a subset of the NX APIs defined in 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: ``include/nuttx/nx/nx.h``. The following configuration options can be selected:
@@ -1,4 +1,4 @@
``nxdemo`` ``nxdemo`` NX Demo "Graphic test" example
========== =========================================
TODO TODO
@@ -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 A very simple graphics example that just says Hello, World! in the center of
the display. the display.
@@ -1,4 +1,4 @@
``nxscope`` ``nxscope`` NxScope library example
=========== ===================================
TODO TODO
@@ -1,4 +1,4 @@
``obd2`` ``obd2`` OBD-II application example
======== ===================================
A simple test of ``apps/canutils/libobd2``. A simple test of ``apps/canutils/libobd2``.
@@ -1,4 +1,4 @@
``opencyphal`` ``opencyphal`` OpenCyphal Cyphal/CAN example
============== ============================================
TODO TODO
@@ -1,5 +1,5 @@
``pdcurses`` ``pdcurses`` pdcurses demos
============ ===========================
This directory contains demonstration programs to show and test the capabilities This directory contains demonstration programs to show and test the capabilities
of ``pdcurses`` libraries. Some of them predate PDCurses, PCcurses or even of ``pdcurses`` libraries. Some of them predate PDCurses, PCcurses or even
@@ -1,4 +1,4 @@
``pf_ieee802154`` ``pf_ieee802154`` PF_IEEE802154 example
================= ======================================
TODO TODO
@@ -1,5 +1,5 @@
``pipe`` ``pipe`` Pipe example
======== =====================
A test of the ``mkfifo()`` and ``pipe()`` APIs. Requires ``CONFIG_PIPES`` A test of the ``mkfifo()`` and ``pipe()`` APIs. Requires ``CONFIG_PIPES``
@@ -1,5 +1,5 @@
``poll`` ``poll`` Poll example
======== =====================
A test of the ``poll()`` and ``select()`` APIs using FIFOs and, if available, 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 ``stdin``, and a TCP/IP socket. In order to use the TCP/IP select test, you must
@@ -1,4 +1,4 @@
``popen`` ``popen`` popen() example
========= =========================
TODO TODO
@@ -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 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 ``examples/elf``. As a result, these tests are built using the relocatable ELF
@@ -1,5 +1,5 @@
``powerled`` ``powerled`` Powerled driver example
============ ====================================
This is a powerled driver example application. This application support three This is a powerled driver example application. This application support three
operation modes which can be selected from NSH command line: operation modes which can be selected from NSH command line:
@@ -1,4 +1,4 @@
``pppd`` ``pppd`` pppd client example
======== ============================
TODO TODO
@@ -1,5 +1,5 @@
``pwfb`` ``pwfb`` NX Per-Window Framebuffer Text Example
======== ===============================================
A graphics example using pre-window frame buffers. The example shows three A graphics example using pre-window frame buffers. The example shows three
windows containing text moving around, crossing each other from above and from windows containing text moving around, crossing each other from above and from
@@ -1,4 +1,4 @@
``pwlines`` ``pwlines`` NX Per-Window Framebuffer Graphics Example
=========== ======================================================
TODO TODO
@@ -1,4 +1,4 @@
``rpmsgsocket`` ``rpmsgsocket`` Rpmsg socket example
=============== ====================================
TODO TODO
@@ -1,5 +1,5 @@
``serialblaster`` ``serialblaster`` Serial Blaster example
================= ========================================
Sends a repeating pattern (the alphabet) out a serial port continuously. This 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 may be useful if you are trying run down other problems that you think might
@@ -1,5 +1,5 @@
``serialrx`` ``serialrx`` Serial RX example
============ ==============================
Constant receives serial data. This is the complement to ``serialblaster``. This 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 may be useful if you are trying run down other problems that you think might
@@ -1,4 +1,4 @@
``shm_test`` ``shm_test`` SHM example
============ ========================
TODO TODO
@@ -1,4 +1,4 @@
``sht3x`` ``sht3x`` SHT3x sensor example
========= ==============================
TODO TODO
@@ -1,5 +1,5 @@
``stat`` ``stat`` Test of stat(), fstat(), and statfs()
======== ==============================================
A simple test of ``stat()``, ``fstat()``, and ``statfs()``. This is useful primarily 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 for bringing up a new file system and verifying the correctness of these
@@ -1,4 +1,4 @@
``sx127x_demo`` ``SX127X`` Radio ``sx127x_demo`` SX127X Radio
================================ ============================
This example demonstrates the use of the ``SX127X`` radio. This example demonstrates the use of the ``SX127X`` radio.
@@ -1,5 +1,5 @@
``system`` ``system`` System() example
========== ===========================
This is a simple test of the ``system()`` command. The test simply executes this This is a simple test of the ``system()`` command. The test simply executes this
``system`` command: ``system`` command:
@@ -1,5 +1,5 @@
``tcp_ipc_client`` ``tcp_ipc_client`` Client for TCP IPC NuttX
================== ===========================================
What's this? What's this?
------------ ------------
@@ -1,5 +1,5 @@
``tcp_ipc_server`` ``tcp_ipc_server`` Server for TCP IPC NuttX
================== ===========================================
What's this? What's this?
------------ ------------
@@ -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``. 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 It is configured to work in the Linux user-mode simulation and has not been
@@ -1,5 +1,5 @@
``timer`` ``timer`` Timer example
========= =======================
This is a simple test of the timer driver (see ``include/nuttx/timers/timer.h``). This is a simple test of the timer driver (see ``include/nuttx/timers/timer.h``).
@@ -1,5 +1,5 @@
``timer_gpio`` ``timer_gpio`` Timer GPIO example
============== =================================
This example uses the timer interrupt to periodically change the state of a 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. digital output. The digital output may be a relay, a led or anything else.

Some files were not shown because too many files have changed in this diff Show More