Documentation: fix ugly formating around some inline literals

This commit is contained in:
raiden00pl 2023-10-27 17:22:27 +02:00 committed by Alan Carvalho de Assis
parent 770df6d820
commit 579a35dc68
9 changed files with 26 additions and 26 deletions

View File

@ -16,9 +16,9 @@ The NuttX analog drivers are split into two parts:
- Common analog logic and share-able analog drivers reside in the - Common analog logic and share-able analog drivers reside in the
``drivers/analog/``. ``drivers/analog/``.
- Platform-specific drivers reside in - Platform-specific drivers reside in
``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* directory ``arch/<architecture>//src/<hardware>`` directory
for the specific processor *<architecture>* and for the for the specific processor ``<architecture>`` and for the
specific *<chip>* analog peripheral devices. specific ``<chip>`` analog peripheral devices.
ADC Drivers ADC Drivers
----------- -----------

View File

@ -23,9 +23,9 @@ Files supporting CAN can be found in the following locations:
- **"Upper Half" Driver**. The generic, "upper half" CAN driver - **"Upper Half" Driver**. The generic, "upper half" CAN driver
resides at ``drivers/can.c``. resides at ``drivers/can.c``.
- **"Lower Half" Drivers**. Platform-specific CAN drivers reside - **"Lower Half" Drivers**. Platform-specific CAN drivers reside
in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* in ``arch/<architecture>/src/<hardware>``
directory for the specific processor *<architecture>* and for directory for the specific processor ``<architecture>`` and for
the specific *<chip>* CAN peripheral devices. the specific ``<chip>`` CAN peripheral devices.
**Usage Note**: When reading from the CAN driver multiple messages **Usage Note**: When reading from the CAN driver multiple messages
may be returned, depending on (1) the size the returned can may be returned, depending on (1) the size the returned can

View File

@ -27,6 +27,6 @@ Files supporting ws2812 can be found in the following locations:
- **"Upper Half" Driver**. The generic, "upper half" ws2812 driver - **"Upper Half" Driver**. The generic, "upper half" ws2812 driver
resides at ``drivers/leds/ws2812.c``. resides at ``drivers/leds/ws2812.c``.
- **"Lower Half" Drivers**. Platform-specific ws2812 drivers reside - **"Lower Half" Drivers**. Platform-specific ws2812 drivers reside
in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* in ``arch/<architecture>/src/<hardware>``
directory for the specific processor *<architecture>* and for directory for the specific processor ``<architecture>`` and for
the specific *<chip>* ws2812 peripheral devices. the specific ``<chip>`` ws2812 peripheral devices.

View File

@ -24,7 +24,7 @@ following locations:
Encoder driver resides at ``drivers/sensors/qencoder.c``. Encoder driver resides at ``drivers/sensors/qencoder.c``.
- **"Lower Half" Drivers**. Platform-specific Quadrature Encoder - **"Lower Half" Drivers**. Platform-specific Quadrature Encoder
drivers reside in drivers reside in
``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* directory ``arch/<architecture>/src/<hardware>`` directory
for the specific processor *<architecture>* and for the for the specific processor ``<architecture>`` and for the
specific *<chip>* Quadrature Encoder peripheral devices. specific ``<chip>`` Quadrature Encoder peripheral devices.

View File

@ -29,6 +29,6 @@ Files supporting PWM can be found in the following locations:
- **"Upper Half" Driver**. The generic, "upper half" PWM driver - **"Upper Half" Driver**. The generic, "upper half" PWM driver
resides at ``drivers/timers/pwm.c``. resides at ``drivers/timers/pwm.c``.
- **"Lower Half" Drivers**. Platform-specific PWM drivers reside - **"Lower Half" Drivers**. Platform-specific PWM drivers reside
in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* in ``arch/<architecture>/src/<hardware>``
directory for the specific processor *<architecture>* and for directory for the specific processor ``<architecture>`` and for
the specific *<chip>* PWM peripheral devices. the specific ``<chip>`` PWM peripheral devices.

View File

@ -21,6 +21,6 @@ locations:
- **"Upper Half" Driver**. The generic, "upper half" RTC driver - **"Upper Half" Driver**. The generic, "upper half" RTC driver
resides at ``drivers/timers/rtc.c``. resides at ``drivers/timers/rtc.c``.
- **"Lower Half" Drivers**. Platform-specific RTC drivers reside - **"Lower Half" Drivers**. Platform-specific RTC drivers reside
in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* in ``arch/<architecture>/src/<hardware>``
directory for the specific processor *<architecture>* and for directory for the specific processor ``<architecture>`` and for
the specific *<chip>* RTC peripheral devices. the specific ``<chip>`` RTC peripheral devices.

View File

@ -13,9 +13,9 @@ locations:
- **"Upper Half" Driver**. The generic, "upper half" timer driver - **"Upper Half" Driver**. The generic, "upper half" timer driver
resides at ``drivers/timers/timer.c``. resides at ``drivers/timers/timer.c``.
- **"Lower Half" Drivers**. Platform-specific timer drivers - **"Lower Half" Drivers**. Platform-specific timer drivers
reside in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* reside in ``arch/<architecture>/src/<hardware>``
directory for the specific processor *<architecture>* and for directory for the specific processor ``<architecture>`` and for
the specific *<chip>* timer peripheral devices. the specific ``<chip>`` timer peripheral devices.
There are two ways to enable Timer Support along with the Timer Example. The There are two ways to enable Timer Support along with the Timer Example. The
first is faster and simpler. Just run the following command to use a ready first is faster and simpler. Just run the following command to use a ready

View File

@ -24,9 +24,9 @@ following locations:
timer driver resides at ``drivers/timers/watchdog.c``. timer driver resides at ``drivers/timers/watchdog.c``.
- **"Lower Half" Drivers**. Platform-specific watchdog timer - **"Lower Half" Drivers**. Platform-specific watchdog timer
drivers reside in drivers reside in
``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* directory ``arch/<architecture>//src/<hardware>`` directory
for the specific processor *<architecture>* and for the for the specific processor ``<architecture>`` and for the
specific *<chip>* watchdog timer peripheral devices. specific ``<chip>`` watchdog timer peripheral devices.
There are two ways to enable Watchdog Timer Support along with the Watchdog Example. There are two ways to enable Watchdog Timer Support along with the Watchdog Example.
The first is faster and simpler. Just run the following command to use a ready config The first is faster and simpler. Just run the following command to use a ready config

View File

@ -30,9 +30,9 @@ found in the following locations:
touchscreen drivers reside in the directory ``drivers/input``. touchscreen drivers reside in the directory ``drivers/input``.
- **"Lower Half" Drivers**. Platform-specific touchscreen drivers - **"Lower Half" Drivers**. Platform-specific touchscreen drivers
reside in either: (1) The reside in either: (1) The
``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* directory ``arch/<architecture>/src/<hardware>`` directory
for the processor architectures that have build in touchscreen for the processor architectures that have build in touchscreen
controllers or (2) the controllers or (2) the
``boards/``\ *<arch>*\ ``/``\ *<chip>*\ ``/``\ *<board>*\ ``/src/`` ``boards/<arch>/<chip>/<board>/src/``
directory for boards that use an external touchscreen directory for boards that use an external touchscreen
controller chip. controller chip.