mirror of
https://github.com/lvgl/lvgl.git
synced 2026-05-24 00:07:03 +08:00
docs(macros): fix many macro links to API docs (#9533)
This commit is contained in:
+10
-10
@@ -65,21 +65,21 @@ Using Logging
|
||||
|
||||
You use the log module via the following macros:
|
||||
|
||||
- ``LV_LOG_TRACE(text)``
|
||||
- ``LV_LOG_INFO(text)``
|
||||
- ``LV_LOG_WARN(text)``
|
||||
- ``LV_LOG_ERROR(text)``
|
||||
- ``LV_LOG_USER(text)``
|
||||
- ``LV_LOG(text)``
|
||||
- :c:macro:`LV_LOG_TRACE`\ (text)
|
||||
- :c:macro:`LV_LOG_INFO`\ (text)
|
||||
- :c:macro:`LV_LOG_WARN`\ (text)
|
||||
- :c:macro:`LV_LOG_ERROR`\ (text)
|
||||
- :c:macro:`LV_LOG_USER`\ (text)
|
||||
- :c:macro:`LV_LOG`\ (text)
|
||||
|
||||
The first 5 macros append the following information to your ``text``:
|
||||
|
||||
- Log Level name ("Trace", "Info", "Warn", "Error", "User")
|
||||
- \__FILE\_\_
|
||||
- \__LINE\_\_
|
||||
- \__func\_\_
|
||||
- ``__FILE__``
|
||||
- ``__LINE__``
|
||||
- ``__func__``
|
||||
|
||||
``LV_LOG(text)`` is similar to ``LV_LOG_USER`` but has no extra information added.
|
||||
:c:macro:`LV_LOG`\ (text) is similar to :c:macro:`LV_LOG_USER` but has no extra information added.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -13,9 +13,9 @@ metrics directly on your display. It supports both performance monitoring
|
||||
Dependencies
|
||||
************
|
||||
|
||||
- Requires ``LV_USE_LABEL = 1`` in lv_conf.h
|
||||
- Requires ``LV_USE_OBSERVER = 1`` in lv_conf.h
|
||||
- Requires ``LV_USE_SYSMON = 1`` in lv_conf.h
|
||||
- Requires :c:macro:`LV_USE_LABEL` = 1 in lv_conf.h
|
||||
- Requires :c:macro:`LV_USE_OBSERVER` = 1 in lv_conf.h
|
||||
- Requires :c:macro:`LV_USE_SYSMON` = 1 in lv_conf.h
|
||||
|
||||
|
||||
|
||||
@@ -168,4 +168,4 @@ Timers
|
||||
|
||||
- Performance: ``perf_update_timer_cb``
|
||||
- Memory: ``mem_update_timer_cb``
|
||||
- Default period: 300ms (``LV_SYSMON_REFR_PERIOD_DEF``)
|
||||
- Default period: 300ms (:c:macro:`LV_SYSMON_REFR_PERIOD_DEF`)
|
||||
|
||||
@@ -27,7 +27,7 @@ where there are no memory constraints.
|
||||
Usage
|
||||
*****
|
||||
|
||||
The Test module can be enabled by configuring ``LV_USE_TEST`` to a non-zero value,
|
||||
The Test module can be enabled by configuring :c:macro:`LV_USE_TEST` to a non-zero value,
|
||||
and it consists of the following components:
|
||||
|
||||
- Helpers
|
||||
@@ -56,7 +56,7 @@ widget coordinates are recalculated.
|
||||
Memory Usage
|
||||
~~~~~~~~~~~~
|
||||
|
||||
If ``LV_USE_STDLIB_MALLOC`` is set to ``LV_STDLIB_BUILTIN``, memory usage and memory leaks can be monitored.
|
||||
If :c:macro:`LV_USE_STDLIB_MALLOC` is set to :c:macro:`LV_STDLIB_BUILTIN`, memory usage and memory leaks can be monitored.
|
||||
|
||||
.. code-block:: c
|
||||
|
||||
@@ -137,7 +137,7 @@ This function works in a practical way:
|
||||
|
||||
- If the folder(s) referenced in ``fn_ref`` do not exist, they will be created automatically.
|
||||
- If the reference image is not found, it will be created automatically from the rendered screen
|
||||
(unless ``LV_TEST_SCREENSHOT_CREATE_REFERENCE_IMAGE`` is ``0``).
|
||||
(unless :c:macro:`LV_TEST_SCREENSHOT_CREATE_REFERENCE_IMAGE` is ``0``).
|
||||
- If the comparison fails, an ``<image_name>_err.png`` file will be created with the rendered content next to the reference image.
|
||||
- If the comparison fails, the X and Y coordinates of the first divergent pixel, along with the actual and expected colors, will also be printed.
|
||||
|
||||
@@ -162,10 +162,10 @@ To read and decode PNG images and to store the converted rendered image, a few M
|
||||
|
||||
|
||||
The screenshot comparison uses ``lodepng`` which is built-in to LVGL and just needs to be enabled with
|
||||
``LV_USE_LODEPNG``.
|
||||
:c:macro:`LV_USE_LODEPNG`.
|
||||
|
||||
To avoid making the entire Test module dependent on ``lodepng``, screenshot comparison can be individually enabled by
|
||||
``LV_USE_TEST_SCREENSHOT_COMPARE``.
|
||||
:c:macro:`LV_USE_TEST_SCREENSHOT_COMPARE`.
|
||||
|
||||
|
||||
.. _test_api:
|
||||
|
||||
Reference in New Issue
Block a user