git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-08 21:53:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

doc: polishing++

Browse source
This commit is contained in:
Hermet Park 2024-06-27 19:03:09 +09:00
parent ae4e9d003c
commit 0ecd09e7ff
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
inc/thorvg.h
View file

@ -545,7 +545,7 @@ public:
* *
* This function provides the list of paint nodes, allowing users a direct opportunity to modify the scene tree. * This function provides the list of paint nodes, allowing users a direct opportunity to modify the scene tree.
* *
* @warning Please avoid accessing the paints during Canvas update/draw. You can access them after calling sync(). * @warning Please avoid accessing the paints during Canvas update/draw. You can access them after calling sync().
* @see Canvas::sync() * @see Canvas::sync()
* *
* @note Experimental API * @note Experimental API
@ -1216,7 +1216,7 @@ public:
* @retval Result::InvalidArguments In case no data are provided or the @p size is zero or less. * @retval Result::InvalidArguments In case no data are provided or the @p size is zero or less.
* @retval Result::NonSupport When trying to load a file with an unknown extension. * @retval Result::NonSupport When trying to load a file with an unknown extension.
* *
* @warning: It's the user responsibility to release the @p data memory. * @warning It's the user responsibility to release the @p data memory.
* *
* @note If you are unsure about the MIME type, you can provide an empty value like @c "", and thorvg will attempt to figure it out. * @note If you are unsure about the MIME type, you can provide an empty value like @c "", and thorvg will attempt to figure it out.
* @since 0.5 * @since 0.5
@ -1354,7 +1354,7 @@ public:
* *
* This function provides the list of paint nodes, allowing users a direct opportunity to modify the scene tree. * This function provides the list of paint nodes, allowing users a direct opportunity to modify the scene tree.
* *
* @warning Please avoid accessing the paints during Scene update/draw. You can access them after calling Canvas::sync(). * @warning Please avoid accessing the paints during Scene update/draw. You can access them after calling Canvas::sync().
* @see Canvas::sync() * @see Canvas::sync()
* @see Scene::push() * @see Scene::push()
* @see Scene::clear() * @see Scene::clear()
@ -1502,7 +1502,7 @@ public:
* @retval Result::NonSupport When trying to load a file with an unsupported extension. * @retval Result::NonSupport When trying to load a file with an unsupported extension.
* @retval Result::InsufficientCondition If attempting to unload the font data that has not been previously loaded. * @retval Result::InsufficientCondition If attempting to unload the font data that has not been previously loaded.
* *
* @warning: It's the user responsibility to release the @p data memory. * @warning It's the user responsibility to release the @p data memory.
* *
* @note To unload the font data loaded using this API, pass the proper @p name and @c nullptr as @p data. * @note To unload the font data loaded using this API, pass the proper @p name and @c nullptr as @p data.
* @note If you are unsure about the MIME type, you can provide an empty value like @c "", and thorvg will attempt to figure it out. * @note If you are unsure about the MIME type, you can provide an empty value like @c "", and thorvg will attempt to figure it out.
@ -1643,8 +1643,6 @@ public:
* *
* @brief A class for the rendering graphic elements with a GL raster engine. * @brief A class for the rendering graphic elements with a GL raster engine.
* *
* @warning Please do not use it. This class is not fully supported yet.
*
* @since 0.14 * @since 0.14
*/ */
class TVG_API GlCanvas final : public Canvas class TVG_API GlCanvas final : public Canvas