From a903fc3d758cd009a849f517ba4595f1dbc8a2c7 Mon Sep 17 00:00:00 2001 From: bjsylvia Date: Fri, 20 Dec 2024 11:06:28 +0800 Subject: [PATCH] docs(details): fix typos (#7484) Signed-off-by: bjsylvia --- docs/details/integration/chip/nxp.rst | 2 +- docs/details/integration/chip/renesas.rst | 4 ++-- docs/details/integration/driver/display/st_ltdc.rst | 2 +- docs/details/integration/driver/wayland.rst | 2 +- .../details/integration/os/buildroot/image_generation.rst | 2 +- docs/details/integration/os/yocto/lvgl_recipe.rst | 8 ++++---- docs/details/main-components/animation.rst | 4 ++-- docs/details/main-components/indev.rst | 2 +- docs/details/other-components/observer.rst | 2 +- docs/details/widgets/chart.rst | 2 +- docs/details/widgets/lottie.rst | 2 +- docs/details/widgets/slider.rst | 2 +- docs/details/widgets/switch.rst | 2 +- docs/details/widgets/win.rst | 2 +- 14 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/details/integration/chip/nxp.rst b/docs/details/integration/chip/nxp.rst index 84013cf32..a56d41ca8 100644 --- a/docs/details/integration/chip/nxp.rst +++ b/docs/details/integration/chip/nxp.rst @@ -221,7 +221,7 @@ Basic initialization: ^^^^^^^^^^^^^^^^^^^^^ Initialize VGLite GPU before calling :cpp:func:`lv_init()` by specifying the -width/height of tessellation window. The default values for tesselation width +width/height of tessellation window. The default values for tessellation width and height, and command buffer size are in the SDK file "vglite_support.h". .. code-block:: c diff --git a/docs/details/integration/chip/renesas.rst b/docs/details/integration/chip/renesas.rst index 525817f58..4aa7b9e55 100644 --- a/docs/details/integration/chip/renesas.rst +++ b/docs/details/integration/chip/renesas.rst @@ -113,7 +113,7 @@ Get started with the Renesas ecosystem - Browse the cloned folder and press ``Finish``. - Double click on ``configuration.xml``. This will activate the `Configuration Window`. - Renesas' Flexible Software Package (FSP) incudes BSP and HAL layer support extended with multiple RTOS variants and other middleware stacks. + Renesas' Flexible Software Package (FSP) includes BSP and HAL layer support extended with multiple RTOS variants and other middleware stacks. The components will be available via code generation, including the entry point of *"main.c"*. Press ``Generate Project Content`` in the top right corner. @@ -174,7 +174,7 @@ Get started with the Renesas ecosystem - Select the cloned folder and press ``Finish``. - Double click on ``RX72N_EnVision_LVGL.scfg``. This will activate the `Configuration Window`. - Renesas' Smart Configurator (SMC) incudes BSP and HAL layer support extended with multiple RTOS variants and other middleware stacks. + Renesas' Smart Configurator (SMC) includes BSP and HAL layer support extended with multiple RTOS variants and other middleware stacks. The components will be available via code generation, including the entry point of the application. Press ``Generate Code`` in the top right corner. diff --git a/docs/details/integration/driver/display/st_ltdc.rst b/docs/details/integration/driver/display/st_ltdc.rst index 7f3ccb905..cd52e8f14 100644 --- a/docs/details/integration/driver/display/st_ltdc.rst +++ b/docs/details/integration/driver/display/st_ltdc.rst @@ -21,7 +21,7 @@ All permutations of the below options are well supported. - single or double buffered - direct or partial render mode - OS and no OS -- paralellized flushing with DMA2D (only for partial render mode) +- parallelized flushing with DMA2D (only for partial render mode) If OS is enabled, a synchronization primitive will be used to give the thread a chance to yield to other threads while blocked, diff --git a/docs/details/integration/driver/wayland.rst b/docs/details/integration/driver/wayland.rst index 115ffd2de..ea87d41d2 100644 --- a/docs/details/integration/driver/wayland.rst +++ b/docs/details/integration/driver/wayland.rst @@ -62,7 +62,7 @@ An example simulator is available in this `repo System hostname``. + - System host name to ``lvgl-buildroot`` under ``system_configuration > System hostname``. - Root password to ``lvgl-buildroot`` under ``system_configuration > Root password``. - Enable SSH in ``target-packages > Networking applications > openssh`` diff --git a/docs/details/integration/os/yocto/lvgl_recipe.rst b/docs/details/integration/os/yocto/lvgl_recipe.rst index ebb1f4a6c..9d2330f0d 100644 --- a/docs/details/integration/os/yocto/lvgl_recipe.rst +++ b/docs/details/integration/os/yocto/lvgl_recipe.rst @@ -503,7 +503,7 @@ Compile (do_compile) This is a optional steps, executes if compilation is available. If there are any compilation steps, then these steps are define in - do_compile() funtion of bitbake. + do_compile() function of bitbake. Like in the previous task, this is handle by ``inherit cmake``. @@ -583,10 +583,10 @@ To generate an SDK of the environment, run the following command: bitbake core-image-base -c populate_sdk -This will create a sript ``build/tmp/deploy/sdk/ +This will create a script ``build/tmp/deploy/sdk/ poky-glibc-x86_64-core-image-base-cortexa53-raspberrypi3-64-toolchain-5.0.4. sh``. This script allows you to install the SDK where you prefer. Here is the -execution output of the scrips +execution output of the script .. code-block:: bash @@ -652,7 +652,7 @@ directory tree should look like the following Create a recipe =============== -Following this structure, create a folder containing the recipies to build 1 +Following this structure, create a folder containing the recipes to build 1 or multiple applications using lvgl .. code-block:: diff --git a/docs/details/main-components/animation.rst b/docs/details/main-components/animation.rst index c2b554867..c5888738c 100644 --- a/docs/details/main-components/animation.rst +++ b/docs/details/main-components/animation.rst @@ -46,7 +46,7 @@ Examples of the latter are: :cpp:expr:`lv_obj_set_x(widget, value)` or :cpp:expr:`lv_obj_set_width(widget, value)`. This makes it very convenient to apply to the appearance (and other attributes) of UI -componenets. But you can provide your own "set" functions, and so the application of +components. But you can provide your own "set" functions, and so the application of Animations is really limited only by your imagination. The number of Animations that can be playing at the same time for a given object with @@ -210,7 +210,7 @@ directions using :cpp:expr:`lv_anim_set_reverse_delay(&anim_template, delay_in_m .. _animation_start: -Starting an Amination +Starting an Animation ********************* After you have set up your :cpp:type:`lv_anim_t` object, it is important to realize diff --git a/docs/details/main-components/indev.rst b/docs/details/main-components/indev.rst index 2a0d63b18..10122470d 100644 --- a/docs/details/main-components/indev.rst +++ b/docs/details/main-components/indev.rst @@ -187,7 +187,7 @@ and ``gesture_type`` fields of the structure ``lv_indev_data_t`` /* An array that stores the collected touch events */ static lv_indev_touch_data_t touches[10]; - /* A counter that needs to be incremented each time a touch event is recieved */ + /* A counter that needs to be incremented each time a touch event is received */ static uint8_t touch_cnt; static void touch_read_callback(lv_indev_t * drv, lv_indev_data_t * data) diff --git a/docs/details/other-components/observer.rst b/docs/details/other-components/observer.rst index f32307435..c7656f240 100644 --- a/docs/details/other-components/observer.rst +++ b/docs/details/other-components/observer.rst @@ -178,7 +178,7 @@ To unsubscribe a widget from a given or all subject use: .. code-block:: c - lv_obj_remove_from_subject(widget, subject); /* `subject` can be NULL to unsubcribe from all */ + lv_obj_remove_from_subject(widget, subject); /* `subject` can be NULL to unsubscribe from all */ .. _observer_subject_groups: diff --git a/docs/details/widgets/chart.rst b/docs/details/widgets/chart.rst index 96d180687..849e23348 100644 --- a/docs/details/widgets/chart.rst +++ b/docs/details/widgets/chart.rst @@ -92,7 +92,7 @@ Update mode Chart layers ------------ When a chart is drawn, certain things appear on top of other things, in this -oder, from back to front: +order, from back to front: - The chart's background (with optional division lines) - Each data series: diff --git a/docs/details/widgets/lottie.rst b/docs/details/widgets/lottie.rst index dc098a9b1..bf60e9fba 100644 --- a/docs/details/widgets/lottie.rst +++ b/docs/details/widgets/lottie.rst @@ -44,7 +44,7 @@ Set a buffer ------------ In order to render the animation a buffer needs to be assigned to the Lottie Widget. -The animations are rendered in ARGB8888 format, therefor the buffer's size should be equal to +The animations are rendered in ARGB8888 format, therefore the buffer's size should be equal to ``target_width x target_height x 4`` bytes. To keep the buffer size and the animation size consistent, diff --git a/docs/details/widgets/slider.rst b/docs/details/widgets/slider.rst index 4c0e9e209..71d6ed0e3 100644 --- a/docs/details/widgets/slider.rst +++ b/docs/details/widgets/slider.rst @@ -47,7 +47,7 @@ Once a Slider is created, it has: - default range of [0..100], - horizontal orientation, with - default width of approximately 2 inches (according to configured value of :c:macro:`LV_DPI_DEF`), -- default hight of approximately 1/10 inch (according to configured value of :c:macro:`LV_DPI_DEF`). +- default height of approximately 1/10 inch (according to configured value of :c:macro:`LV_DPI_DEF`). To set different values use: diff --git a/docs/details/widgets/switch.rst b/docs/details/widgets/switch.rst index 6563e9e53..9f0e732f0 100644 --- a/docs/details/widgets/switch.rst +++ b/docs/details/widgets/switch.rst @@ -55,7 +55,7 @@ programmatically. Change orientation ------------------ -Swith a Switch is created, its default orientation is +With a Switch is created, its default orientation is :cpp:enumerator:`LV_SWITCH_ORIENTATION_AUTO`, which causes it to be oriented based on ``width`` and ``height``. You can change this behavior using :cpp:expr:`lv_switch_set_orientation(widget, orientation)`. Possible values for diff --git a/docs/details/widgets/win.rst b/docs/details/widgets/win.rst index 914c9ed5c..67db7735c 100644 --- a/docs/details/widgets/win.rst +++ b/docs/details/widgets/win.rst @@ -74,7 +74,7 @@ functions can be called in any order, any number of times. on the far right of the Header. - :cpp:expr:`lv_win_add_button(win, icon, button_width)` adds a Button with the - specified width that occupies the full hight of the Header (its parent). If + specified width that occupies the full height of the Header (its parent). If ``icon`` is not NULL, an image is created, centered on the button, using ``icon`` as its image source. All valid image sources are supported, but a common source to use is one of the ``LV_SYMBOL_...`` macros, such as :c:macro:`LV_SYMBOL_CLOSE`