docs(doc-gen): eliminate all non-API-page errors (#8035)

2026-05-20 12:32:18 +08:00 · 2025-04-03 03:49:27 -06:00
parent e3d704b43b
commit 153a169fee
8 changed files with 42 additions and 36 deletions
@@ -7,7 +7,7 @@ Events
 Overview
 ********

-``<lv_event>`` tags can be added as a child of any widget to react to user inputs or other value changes.
+``<lv_event>`` tags can be added as a child of any Widget to react to user inputs or other value changes.

 Right now, only a single event type is supported to call user-defined callbacks.

@@ -20,12 +20,13 @@ Call function
 User-defined functions can be called like this:

 .. code-block:: xml
-	<view>
-		<lv_button width="200" height="100">
-			<lv_event-call_function callback="my_callback_1" trigger="clicked" user_data="some_text"/>
-			<lv_label text="Hello"/>
-		</lv_button>
-	</view>
+
+    <view>
+      <lv_button width="200" height="100">
+        <lv_event-call_function callback="my_callback_1" trigger="clicked" user_data="some_text"/>
+        <lv_label text="Hello"/>
+      </lv_button>
+    </view>

 When the XML is loaded at runtime, the callback name needs to be mapped to a function by using:
 ``lv_xml_register_event_cb("my_callback_1", an_event_handler)``
@@ -37,9 +38,10 @@ In the exported C code, it is assumed that there is a function with the exact na
 For example, ``callback="my_callback_1"`` will be exported as:

 .. code-block:: c
-  void my_callback_1(lv_event_t * e); /* At the beginning of the exported file */

-  lv_obj_add_event_cb(obj, my_callback_1, LV_EVENT_CLICKED, "some_text");
+    void my_callback_1(lv_event_t * e); /* At the beginning of the exported file */
+
+    lv_obj_add_event_cb(obj, my_callback_1, LV_EVENT_CLICKED, "some_text");

 For triggers, all LVGL event types are supported with straightforward mapping:

@@ -3,29 +3,34 @@ Viewe
 =====

 `Viewe <https://viewedisplay.com/>`__ is a high-tech enterprise specializing
-in comprehensive display solutions, including display panels, touch interfaces, 
-and embedded smart displays. They integrate research and development, production, 
-and sales services, focusing on professionalism, dedication, innovation, 
-and ambition to lead in the display and graphical user interface (GUI) 
+in comprehensive display solutions, including display panels, touch interfaces,
+and embedded smart displays. They integrate research and development, production,
+and sales services, focusing on professionalism, dedication, innovation,
+and ambition to lead in the display and graphical user interface (GUI)
 industry.

 - TFT Displays
- - Standard Display
- - Sunlight Readable Display
- - Bar Display/Stretched Display
- - Square Display
- - Round Display
+
+    - Standard Display
+    - Sunlight Readable Display
+    - Bar Display/Stretched Display
+    - Square Display
+    - Round Display
+
 - Smart Display
- - Uart Smart Display
- - IOT_AIOT Smart Display
- - HDMI Display_Raspberry Pi Display
- - Arduino Display
+
+    - Uart Smart Display
+    - IOT_AIOT Smart Display
+    - HDMI Display_Raspberry Pi Display
+    - Arduino Display
+
+

 UART Smart Displays
 *******************

-The Viewe UART Smart Displays are a series of displays that use 
-ESP32 microcontrollers and have IO interface for connecting to 
+The Viewe UART Smart Displays are a series of displays that use
+ESP32 microcontrollers and have IO interface for connecting to
 peripherals.

 lv_port_viewe_7_espidf
@@ -529,7 +529,7 @@ Project setup:
   - "src/draw/nxp/g2d/lv_draw_buf_g2d.c": draw buffer callbacks
   - "src/draw/nxp/g2d/lv_draw_g2d_fill.c": fill area
   - "src/draw/nxp/g2d/lv_draw_g2d_img.c": blit image (w/ optional recolor or
-   transformation)
+     transformation)
   - "src/draw/nxp/g2d/lv_draw_g2d.c": draw unit initialization
   - "src/draw/nxp/g2d/lv_draw_g2d_buf_map.c": hash map for g2d buffers
   - "src/draw/nxp/g2d/lv_g2d_utils.c": function helpers
@@ -1,11 +1,11 @@
 .. _renesas:

-.. |sup2|   unicode:: U+000B2 .. SUPERSCRIPT TWO
-
 =======
 Renesas
 =======

+.. |sup2|   unicode:: U+000B2 .. SUPERSCRIPT TWO
+
 `Renesas <https://renesas.com/>`__ is an official partner of LVGL. Therefore, LVGL contains built-in support for
 `Dave2D <https://www.renesas.com/document/mas/tes-dave2d-driver-documentation>`__ (the GPU of Renesas) and we also maintain
 ready-to-use Renesas projects.
@@ -1,11 +1,11 @@
 .. _renesas_glcdc:

-.. |sup2|   unicode:: U+000B2 .. SUPERSCRIPT TWO
-
 =============
 Renesas GLCDC
 =============

+.. |sup2|   unicode:: U+000B2 .. SUPERSCRIPT TWO
+
 Overview
 --------

@@ -332,9 +332,9 @@ Once a gesture is recognized or ended, a ``LV_EVENT_GESTURE`` is sent. The user
 gather more information about the gesture:

 - ``lv_event_get_gesture_type(lv_event_t * gesture_event)``: Get the type of the gesture. To be
-used to check which multi-touch gesture is currently reported.
+  used to check which multi-touch gesture is currently reported.
 - ``lv_indev_gesture_state_t lv_event_get_gesture_state(lv_event_t * gesture_event, lv_indev_gesture_type_t type)``: Get the
-state of the gesture. It can be one of those:
+  state of the gesture. It can be one of those:

  - ``LV_INDEV_GESTURE_STATE_NONE``: The gesture is not active.
  - ``LV_INDEV_GESTURE_STATE_RECOGNIZED``: The gesture is recognized and can be used.
@@ -1,7 +1,5 @@
 .. _lv_image:

-.. |deg|    unicode:: U+000B0 .. DEGREE SIGN
-
 ================
 Image (lv_image)
 ================
@@ -9,6 +7,8 @@ Image (lv_image)
 Overview
 ********

+.. |deg|    unicode:: U+000B0 .. DEGREE SIGN
+
 Images are Widgets that display images from flash (as arrays) or
 from files. Images can display symbols (``LV_SYMBOL_...``) as well.

@@ -1,4 +1,3 @@
-
 Drawing on the Canvas and rotate
 --------------------------------

@@ -62,10 +61,10 @@ Draw Fancy Letter Effects
 -------------------------

 .. lv_example:: widgets/canvas/lv_example_canvas_10
-:language: c
+  :language: c


 Draw Fancy Letter Effects 2
 ---------------------------
 .. lv_example:: widgets/canvas/lv_example_canvas_11
-:language: c
+  :language: c