Documentation: add dummy apps descriptions

The apps description is empty for now but allows to generate nice tables of content with all nuttx-apps functionalities.
This commit is contained in:
raiden00pl 2023-10-24 15:35:33 +02:00 committed by Xiang Xiao
parent 0616796185
commit d1ebe6cd24
161 changed files with 486 additions and 162 deletions

View File

@ -0,0 +1,4 @@
==================================
``fmsynth`` FM Synthesizer Library
==================================

View File

@ -9,6 +9,3 @@ Audio Utility libraries
:caption: Contents :caption: Contents
*/index* */index*
- fmsynth - FM Synthesizer Library
- nxaudio - NX Audio Library

View File

@ -0,0 +1,3 @@
============================
``nxaudio`` NX Audio Library
============================

View File

@ -0,0 +1,3 @@
===============================
``coremark`` CoreMark Benchmark
===============================

View File

@ -2,4 +2,10 @@
Benchmark Applications Benchmark Applications
====================== ======================
- coremark - CoreMark Benchmark .. toctree::
:glob:
:maxdepth: 1
:titlesonly:
:caption: Contents
*/index*

View File

@ -0,0 +1,3 @@
==================================
``candump`` SocketCAN candump tool
==================================

View File

@ -0,0 +1,3 @@
==============================
``canlib`` CAN utility library
==============================

View File

@ -0,0 +1,3 @@
==================================
``cansend`` SocketCAN cansend tool
==================================

View File

@ -2,12 +2,10 @@
CAN Utilities CAN Utilities
============= =============
- candump - SocketCAN candump tool .. toctree::
- canlib - CAN utility library :glob:
- cansend - SocketCAN cansend tool :maxdepth: 1
- lely-canopen - Lely CANopen support :titlesonly:
- libcanutils - CAN-utils support library :caption: Contents
- libdronecan - libcanard DroneCAN Library
- libobd2 - OBD-II Library */index*
- libopencyphal - libcanard OpenCyphal Cyphal/CAN Library
- slcan - SocketCAN slcan tool

View File

@ -0,0 +1,3 @@
=====================================
``lely-canopen`` Lely CANopen support
=====================================

View File

@ -0,0 +1,3 @@
=========================================
``libcanutils`` CAN-utils support library
=========================================

View File

@ -0,0 +1,3 @@
==========================================
``libdronecan`` libcanard DroneCAN Library
==========================================

View File

@ -0,0 +1,3 @@
==========================
``libobd2`` OBD-II Library
==========================

View File

@ -0,0 +1,3 @@
=========================================================
``libopencyphal`` libcanard OpenCyphal Cyphal/CAN Library
=========================================================

View File

@ -0,0 +1,3 @@
==============================
``slcan`` SocketCAN slcan tool
==============================

View File

@ -0,0 +1,3 @@
===========================================
``controlse`` Control Secure Element device
===========================================

View File

@ -9,11 +9,3 @@ Cryptography Library Support
:caption: Contents :caption: Contents
*/index* */index*
- controlse - Control Secure Element device
- libsodium - Libsodium Cryptography Library
- libtomcrypt - LibTomCrypt CrypographyLibrary
- mbedtls - Mbed TLS Cryptography Library
- tinycrypt - TinyCrypt cryptography library
- tinydtls - Eclipse Tinydtls
- wolfssl -

View File

@ -0,0 +1,3 @@
============================================
``libsodium`` Libsodium Cryptography Library
============================================

View File

@ -0,0 +1,3 @@
==============================================
``libtomcrypt`` LibTomCrypt CrypographyLibrary
==============================================

View File

@ -0,0 +1,3 @@
=========================================
``mbedtls`` Mbed TLS Cryptography Library
=========================================

View File

@ -0,0 +1,3 @@
============================================
``tinycrypt`` TinyCrypt cryptography library
============================================

View File

@ -0,0 +1,3 @@
=============================
``tinydtls`` Eclipse Tinydtls
=============================

View File

@ -0,0 +1,3 @@
============================================
``flash_eraseall`` flash_eraseall() function
============================================

View File

@ -9,13 +9,3 @@ File System Utilities
:caption: Contents :caption: Contents
*/index* */index*
- flash_eraseall - flash_eraseall() function
- inih - inih ini file parser
- ipcfg - IP Configuration File Support
- libtinycbor - TinyCBOR Library (RFC 8949)
- mkfatfs - mkfatfs utility
- mkgpt - mkgpt utility
- mkmbr - mkmbr utility
- mksmartfs - mksmartfs utility
- passwd - Password file support

View File

@ -0,0 +1,3 @@
=============================
``inih`` inih ini file parser
=============================

View File

@ -0,0 +1,3 @@
=======================================
``ipcfg`` IP Configuration File Support
=======================================

View File

@ -0,0 +1,3 @@
===========================================
``libtinycbor`` TinyCBOR Library (RFC 8949)
===========================================

View File

@ -0,0 +1,3 @@
===========================
``mkfatfs`` mkfatfs utility
===========================

View File

@ -0,0 +1,3 @@
=======================
``mkgpt`` mkgpt utility
=======================

View File

@ -0,0 +1,3 @@
=======================
``mkmbr`` mkmbr utility
=======================

View File

@ -0,0 +1,3 @@
===============================
``mksmartfs`` mksmartfs utility
===============================

View File

@ -0,0 +1,3 @@
==================================
``passwd`` - Password file support
==================================

View File

@ -1,6 +1,6 @@
========== =========================
Brickmatch ``brickmatch`` Brickmatch
========== =========================
Brickmatch is a kind puzzle game like a mix between tetris and Candy Brickmatch is a kind puzzle game like a mix between tetris and Candy
Crush. It is a 6x6 matrix with blocks (cells) with different colors. Crush. It is a 6x6 matrix with blocks (cells) with different colors.

View File

@ -0,0 +1,3 @@
======================================
``ft80x`` FTDI/BridgeTek FT80x library
======================================

View File

@ -9,10 +9,3 @@ Graphics Support
:caption: Contents :caption: Contents
*/index* */index*
- ft80x - FTDI/BridgeTek FT80x library
- libjpeg - libjpeg JPEG image encoding
- libyuv - libyuv
- screenshot - TIFF screenshot utility
- slcd - Segment LCD Emulaton
- twm4nx - Minimal Tom's Window Manager (TWM) for NuttX (Twm4Nx)

View File

@ -0,0 +1,3 @@
=======================================
``libjpeg`` libjpeg JPEG image encoding
=======================================

View File

@ -0,0 +1,3 @@
=================
``libyuv`` libyuv
=================

View File

@ -0,0 +1,3 @@
======================================
``screenshot`` TIFF screenshot utility
======================================

View File

@ -0,0 +1,3 @@
=============================
``slcd`` Segment LCD Emulaton
=============================

View File

@ -0,0 +1,3 @@
=================================================
``foc`` Field Oriented Control user-space library
=================================================

View File

@ -9,7 +9,3 @@ Industrial Applications
:caption: Contents :caption: Contents
*/index* */index*
- foc - Field Oriented Control user-space library
- scpi - SCPI instrument side parser
- modbus - Modbus support using FreeModbus

View File

@ -0,0 +1,3 @@
====================================
``scpi`` SCPI instrument side parser
====================================

View File

@ -2,4 +2,10 @@
Inertial Libraries Support Inertial Libraries Support
========================== ==========================
- madgwick - Madgwick Fusion Algorithm .. toctree::
:glob:
:maxdepth: 1
:titlesonly:
:caption: Contents
*/index*

View File

@ -0,0 +1,3 @@
======================================
``madgwick`` Madgwick Fusion Algorithm
======================================

View File

@ -0,0 +1,3 @@
==========================================
``duktape`` Duktape JavaScript interpreter
==========================================

View File

@ -12,11 +12,3 @@ incorporated into NuttX.
:caption: Contents :caption: Contents
*/index* */index*
- duktape - Duktape JavaScript interpreter
- luajit - LuaJIT interpreter
- luamodules: cjson, lfs, luasyslog, luv
- quickjs - QuickJS JavaScript interpreter
- toywasm - Toywasm Webassembly Runtime
- wamr - Webassembly Micro Runtime
- wasm3 - WASM3 Webassembly Runtime

View File

@ -15,3 +15,11 @@ toolchain provided math library.
The following configs are recommended for a full featured Lua interpreter: The following configs are recommended for a full featured Lua interpreter:
- ``LIBC_FLOATINGPOINT`` - ``LIBC_FLOATINGPOINT``
- ``SYSTEM_READLINE`` - ``SYSTEM_READLINE``
Lua modules:
- cjson
- lfs
- luasyslog
- luv

View File

@ -0,0 +1,3 @@
=============================
``luajit`` LuaJIT interpreter
=============================

View File

@ -0,0 +1,3 @@
==========================================
``quickjs`` QuickJS JavaScript interpreter
==========================================

View File

@ -0,0 +1,3 @@
=======================================
``toywasm`` Toywasm Webassembly Runtime
=======================================

View File

@ -0,0 +1,3 @@
==================================
``wamr`` Webassembly Micro Runtime
==================================

View File

@ -0,0 +1,3 @@
===================================
``wasm3`` WASM3 Webassembly Runtime
===================================

View File

@ -0,0 +1,3 @@
==================================
``alt1250`` ALT1250 usrsock daemon
==================================

View File

@ -2,5 +2,10 @@
LTE Libraries and NSH Add-Ons LTE Libraries and NSH Add-Ons
============================= =============================
- alt1250 - ALT1250 usrsock daemon .. toctree::
- lapi - LTE Configuration Library :glob:
:maxdepth: 1
:titlesonly:
:caption: Contents
*/index*

View File

@ -0,0 +1,3 @@
==================================
``lapi`` LTE Configuration Library
==================================

View File

@ -2,4 +2,10 @@
Math Library Support Math Library Support
==================== ====================
- libtommath - LibTomMath MPI Math Library .. toctree::
:glob:
:maxdepth: 1
:titlesonly:
:caption: Contents
*/index*

View File

@ -0,0 +1,3 @@
==========================================
``libtommath`` LibTomMath MPI Math Library
==========================================

View File

@ -0,0 +1,3 @@
=========================
``cmsis`` CMSIS Libraries
=========================

View File

@ -0,0 +1,3 @@
============================================
``darknet`` YOLO: Real-Time Object Detection
============================================

View File

@ -2,6 +2,10 @@
Machine Learning Support Machine Learning Support
======================== ========================
- cmsis - CMSIS Libraries .. toctree::
- darknet - YOLO: Real-Time Object Detection :glob:
- libnnablart - NNABLA Runtime Libraries :maxdepth: 1
:titlesonly:
:caption: Contents
*/index*

View File

@ -0,0 +1,3 @@
========================================
``libnnablart`` NNABLA Runtime Libraries
========================================

View File

@ -0,0 +1,3 @@
==================
``chat`` Chat tool
==================

View File

@ -0,0 +1,4 @@
========================================================
``codecs`` CODEC Library: Base64 coding, URL coding, MD5
========================================================

View File

@ -0,0 +1,3 @@
=======================================
``cwebsocket`` WebSocket Client Library
=======================================

View File

@ -0,0 +1,3 @@
========================
``dhcp6c`` DHCPv6 client
========================

View File

@ -10,25 +10,6 @@ Network Utilities
*/index* */index*
- chat - Chat tool
- codecs - CODEC Library: Base64 coding, URL coding, MD5
- cwebsocket - WebSocket Client Library
- dhcp6c - DHCPv6 client
- iptables - iptables libary
- libcurl4nx - cURL4nx HTTP client library
- mqttc - MQTT-C library
- netinit - Network initialization
- netlib - Network support library
- nng - Nanomsg NG
- pppd - PPP server
- ptpd - PTPD client/server
- rexec - Remote execution client
- rexecd - Remote Execution Server
- rtptools - RTP Tools
- wakaama - Eclipse Wakaama (formerly liblwm2m) - an implementation of LWM2M protocol.
- wakeonlan - WakeOnLAN support
uIP Applications uIP Applications
---------------- ----------------

View File

@ -0,0 +1,3 @@
============================
``iptables`` iptables libary
============================

View File

@ -0,0 +1,3 @@
==========================================
``libcurl4nx`` cURL4nx HTTP client library
==========================================

View File

@ -0,0 +1,3 @@
========================
``mqttc`` MQTT-C library
========================

View File

@ -0,0 +1,3 @@
==================================
``netinit`` Network initialization
==================================

View File

@ -0,0 +1,3 @@
==================================
``netlib`` Network support library
==================================

View File

@ -0,0 +1,3 @@
==================
``nng`` Nanomsg NG
==================

View File

@ -0,0 +1,3 @@
===================
``pppd`` PPP server
===================

View File

@ -0,0 +1,3 @@
===========================
``ptpd`` PTPD client/server
===========================

View File

@ -0,0 +1,3 @@
=================================
``rexec`` Remote execution client
=================================

View File

@ -0,0 +1,3 @@
==================================
``rexecd`` Remote Execution Server
==================================

View File

@ -0,0 +1,3 @@
======================
``rtptools`` RTP Tools
======================

View File

@ -0,0 +1,3 @@
================================================================
``wakaama`` Eclipse Wakaama (formerly liblwm2m) - LWM2M protocol
================================================================

View File

@ -0,0 +1,3 @@
===============================
``wakeonlan`` WakeOnLAN support
===============================

View File

@ -2,4 +2,10 @@
Software Define Radio Libraries Software Define Radio Libraries
=============================== ===============================
- liquid_dsp - Liquid DSP Library .. toctree::
:glob:
:maxdepth: 1
:titlesonly:
:caption: Contents
*/index*

View File

@ -0,0 +1,3 @@
=================================
``liquid_dsp`` Liquid DSP Library
=================================

View File

@ -0,0 +1,3 @@
==============================
``adb`` ADB daemon application
==============================

View File

@ -0,0 +1,3 @@
===============================
``argtable3`` ARGTABLE3 library
===============================

View File

@ -0,0 +1,3 @@
===============================
``cachespeed`` CACHE Speed Test
===============================

View File

@ -0,0 +1,3 @@
======================================
``cle`` EMACS-like Command Line Editor
======================================

View File

@ -0,0 +1,3 @@
================================================
``coredump`` Coredump tool capture system status
================================================

View File

@ -0,0 +1,3 @@
===================================
``critmon`` Critcal Section Monitor
===================================

View File

@ -0,0 +1,3 @@
=================================
``cu`` CU minimal serial terminal
=================================

View File

@ -0,0 +1,3 @@
==========================
``dd`` system 'dd' command
==========================

View File

@ -0,0 +1,3 @@
====================================
``dhcp6c`` DHCP IPv6 Address Renewal
====================================

View File

@ -0,0 +1,3 @@
==============================
``dhcpc`` DHCP Address Renewal
==============================

View File

@ -0,0 +1,3 @@
========================================================
``dumpstack`` dumpstack tool for show the task backtrace
========================================================

View File

@ -0,0 +1,3 @@
======================
``fastboot`` fastbootd
======================

View File

@ -0,0 +1,3 @@
=========================
``fdt`` fdt utility tools
=========================

View File

@ -0,0 +1,3 @@
==================
``gcov`` gcov tool
==================

View File

@ -0,0 +1,3 @@
===================
``gdbstub`` GDBSTUB
===================

View File

@ -0,0 +1,3 @@
==========================================
``hex2bin`` Intel HEX to binary conversion
==========================================

View File

@ -0,0 +1,3 @@
====================
``hexed`` Hex editor
====================

View File

@ -0,0 +1,3 @@
===============================
``hostname`` "hostname" command
===============================

View File

@ -9,55 +9,3 @@ System Libraries and NSH Add-Ons
:caption: Contents :caption: Contents
*/index* */index*
- adb - ADB daemon application
- argtable3 - ARGTABLE3 library
- cachespeed - CACHE Speed Test
- cle - EMACS-like Command Line Editor
- coredump - Coredump tool capture system status
- critmon - Critcal Section Monitor
- cu - CU minimal serial terminal
- dd - system 'dd' command
- dhcp6c - DHCP IPv6 Address Renewal
- dhcpc - DHCP Address Renewal
- dumpstack - dumpstack tool for show the task backtrace
- fastboot - fastbootd
- fdt - fdt utility tools
- gcov - gcov tool
- gdbstub - GDBSTUB
- hexed - Hex editor
- hex2bin - Intel HEX to binary conversion
- hostname - 'hostname' command
- input - input tool
- iptables - 'iptables' command
- lm75 - LM75 Temperature
- lzf - LZF compression tool
- mdio - PHY MDIO tool
- memstress - memory stress test
- netdb - netdb interface
- ntpc - NTP Daemon Commands
- nxcamera - NxCamera video test application
- nxlooper - NxLooper audio test application
- nxrecorder - NxRecorder pcm raw data Recorder
- ping - ICMP 'ping' command
- ping6 - ICMPv6 'ping6' command
- popen - popen()/pclose() Functions
- ptpd - PTP daemon commands
- ramspeed - RAM Speed Test
- ramtest - RAM Test
- readline - readline() Support
- sched_note - Scheduler monitor
- setlogmask - 'setlogmask' command
- stackmonitor - Stack Monitor
- system - System Command
- taskset - Taskset Command
- tcpdump - tcpdump command
- tee - Tee Command
- telnet - Telnet chat daemon
- telnetd - Telnet daemon application
- ubloxmodem - u-blox modem configuration tool
- uniqueid - 'uniqueid' command
- uorb - uorb(micro object request broker)
- vi - VI Work-Alike Text Editor
- ofloader - Open flash loader
- zlib - zlib data compression library

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