From e8b506265747d56d2fef4a6be10fbde2b82cd15c Mon Sep 17 00:00:00 2001 From: Mira Grudzinska Date: Thu, 20 Jun 2024 13:53:46 +0200 Subject: [PATCH] docs: descriptions++ --- inc/thorvg.h | 6 +++--- src/bindings/capi/thorvg_capi.h | 3 +-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/inc/thorvg.h b/inc/thorvg.h index 6ef7ea9b..a2ef6c80 100644 --- a/inc/thorvg.h +++ b/inc/thorvg.h @@ -586,10 +586,10 @@ public: * @brief Clear the internal canvas resources that used for the drawing. * * This API sets the total number of paints pushed into the canvas to zero. - * Depending on the value of the @p free argument, the paints are either freed or retained. - * So if you need to update paint properties while maintaining the existing scene structure, you can set @p free = false. + * Depending on the value of the @p paints argument, the paints are either freed or retained. + * So if you need to update paint properties while maintaining the existing scene structure, you can set @p paints = false. * - * @param[in] paints If @c true, The memory occupied by paints is deallocated; otherwise, the paints will be retained on the canvas. + * @param[in] paints If @c true, the memory occupied by paints is deallocated; otherwise, the paints will be retained on the canvas. * @param[in] buffer If @c true, the canvas target buffer is cleared with a zero value. * * @retval Result::Success when succeed, Result::InsufficientCondition otherwise. diff --git a/src/bindings/capi/thorvg_capi.h b/src/bindings/capi/thorvg_capi.h index b59cf4df..22e9f6ec 100644 --- a/src/bindings/capi/thorvg_capi.h +++ b/src/bindings/capi/thorvg_capi.h @@ -565,7 +565,6 @@ TVG_API Tvg_Result tvg_canvas_destroy(Tvg_Canvas* canvas); * * Only the paints pushed into the canvas will be drawing targets. * They are retained by the canvas until you call tvg_canvas_clear(). -* If you know the number of the pushed objects in advance, please call tvg_canvas_reserve(). * * \return Tvg_Result return values: * \retval TVG_RESULT_SUCCESS Succeed. @@ -613,7 +612,7 @@ TVG_DEPRECATED TVG_API Tvg_Result tvg_canvas_reserve(Tvg_Canvas* canvas, uint32_ /*! * \brief Sets the total number of the paints pushed into the canvas to be zero. -* Tvg_Paint objects stored in the canvas are released if @p free is set to @c true, otherwise the memory is not deallocated and +* Tvg_Paint objects stored in the canvas are released if @p paints is set to @c true, otherwise the memory is not deallocated and * all paints should be released manually in order to avoid memory leaks. * * \param[in] canvas The Tvg_Canvas object to be cleared.