From e57879e7b11529e9dad05c5a665b611cf04e8a66 Mon Sep 17 00:00:00 2001 From: Richard Allen Date: Thu, 24 Oct 2024 10:08:07 -0500 Subject: [PATCH] chore(obj_scroll): improve function documentation Signed-off-by: Richard Allen --- src/core/lv_obj_scroll.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/core/lv_obj_scroll.h b/src/core/lv_obj_scroll.h index f2cb2f1033d2..860146fa66d2 100644 --- a/src/core/lv_obj_scroll.h +++ b/src/core/lv_obj_scroll.h @@ -132,7 +132,7 @@ int32_t lv_obj_get_scroll_y(const lv_obj_t * obj); /** * Return the height of the area above the object. - * That is the number of pixels the object can be scrolled down. + * That is the number of pixels the object can be scrolled up. * Normally positive but can be negative when scrolled inside. * @param obj pointer to an object * @return the scrollable area above the object in pixels @@ -150,19 +150,19 @@ int32_t lv_obj_get_scroll_bottom(lv_obj_t * obj); /** * Return the width of the area on the left the object. - * That is the number of pixels the object can be scrolled down. + * That is the number of pixels the object can be scrolled left. * Normally positive but can be negative when scrolled inside. * @param obj pointer to an object - * @return the scrollable area on the left the object in pixels + * @return the scrollable area on the left of the object in pixels */ int32_t lv_obj_get_scroll_left(lv_obj_t * obj); /** * Return the width of the area on the right the object. - * That is the number of pixels the object can be scrolled down. + * That is the number of pixels the object can be scrolled right. * Normally positive but can be negative when scrolled inside. * @param obj pointer to an object - * @return the scrollable area on the right the object in pixels + * @return the scrollable area on the right of the object in pixels */ int32_t lv_obj_get_scroll_right(lv_obj_t * obj);