git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-15 04:24:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

doc common: Add grouping of C++ api and C api

Browse source 
group ThorVG C++ APIs
group ThorVGCapi C APIs
This commit is contained in:
JunsuChoi 2021-04-29 11:36:12 +09:00 • committed by Hermet Park
parent ec1232b9b4
commit d7b3f0103e
2 changed files with 14 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
inc/thorvg.h
View file

@ -49,6 +49,11 @@ class Scene;
class Picture; class Picture;
class Canvas; class Canvas;
/**
* @defgroup ThorVG C++ APIs
*/
/**@{*/
/** /**
* @brief Enumeration specifying the result from the APIs. * @brief Enumeration specifying the result from the APIs.
@ -161,8 +166,6 @@ struct Matrix
/** /**
* @class Paint * @class Paint
* *
* @ingroup ThorVG
*
* @brief A class for managing graphic elements. * @brief A class for managing graphic elements.
* *
* It enables duplication, transformation and composition. * It enables duplication, transformation and composition.
@ -264,8 +267,6 @@ public:
/** /**
* @class Fill * @class Fill
* *
* @ingroup ThorVG
*
* @brief A class representing the gradient fill of the Shape object. * @brief A class representing the gradient fill of the Shape object.
* *
* It contains the information about the gradient colors and their arrangement * It contains the information about the gradient colors and their arrangement
@ -333,8 +334,6 @@ public:
/** /**
* @class Canvas * @class Canvas
* *
* @ingroup ThorVG
*
* @brief A class for drawing graphic elements. * @brief A class for drawing graphic elements.
* *
* It stores all Paint objects (Shape, Scene, Picture) and creates the buffer, which can be drawn on the screen. * It stores all Paint objects (Shape, Scene, Picture) and creates the buffer, which can be drawn on the screen.
@ -412,8 +411,6 @@ public:
/** /**
* @class LinearGradient * @class LinearGradient
* *
* @ingroup ThorVG
*
* @brief A class representing the linear gradient fill of the Shape object. * @brief A class representing the linear gradient fill of the Shape object.
* *
* Besides the APIs inherited from the Fill class, it enables setting and getting the linear gradient bounds. * Besides the APIs inherited from the Fill class, it enables setting and getting the linear gradient bounds.
@ -467,8 +464,6 @@ public:
/** /**
* @class RadialGradient * @class RadialGradient
* *
* @ingroup ThorVG
*
* @brief A class representing the radial gradient fill of the Shape object. * @brief A class representing the radial gradient fill of the Shape object.
* *
*/ */
@ -516,8 +511,6 @@ public:
/** /**
* @class Shape * @class Shape
* *
* @ingroup ThorVG
*
* @brief A class representing two-dimensional figures and their properties. * @brief A class representing two-dimensional figures and their properties.
* *
* The shapes of the figures in the Shape object are stored as the sub-paths in the path. * The shapes of the figures in the Shape object are stored as the sub-paths in the path.
@ -853,8 +846,6 @@ public:
/** /**
* @class Picture * @class Picture
* *
* @ingroup ThorVG
*
* @brief A class representing an image read in one of the supported formats: svg, png and raw. * @brief A class representing an image read in one of the supported formats: svg, png and raw.
* Besides the methods inherited from the Paint, it provides methods to load the image, * Besides the methods inherited from the Paint, it provides methods to load the image,
* to change its size and to get the basic information. * to change its size and to get the basic information.
@ -968,8 +959,6 @@ public:
/** /**
* @class Scene * @class Scene
* *
* @ingroup ThorVG
*
* @brief A class enabling to hold many Paint objects. * @brief A class enabling to hold many Paint objects.
* *
* As a whole they can be transformed, their transparency can be changed, or the composition * As a whole they can be transformed, their transparency can be changed, or the composition
@ -1024,8 +1013,6 @@ public:
/** /**
* @class SwCanvas * @class SwCanvas
* *
* @ingroup ThorVG
*
* @brief A class for the rasterisation of graphic elements with a software engine. * @brief A class for the rasterisation of graphic elements with a software engine.
* *
*/ */
@ -1073,8 +1060,6 @@ public:
/** /**
* @class GlCanvas * @class GlCanvas
* *
* @ingroup ThorVG
*
* @brief A class for the rasterisation of graphic elements with the OpenGL engine. * @brief A class for the rasterisation of graphic elements with the OpenGL engine.
* *
*/ */
@ -1102,8 +1087,6 @@ public:
/** /**
* @class Initializer * @class Initializer
* *
* @ingroup ThorVG
*
* @brief A class that enables initialization and termination of the ThorVG engine. * @brief A class that enables initialization and termination of the ThorVG engine.
* *
*/ */
@ -1136,6 +1119,8 @@ public:
_TVG_DISABLE_CTOR(Initializer); _TVG_DISABLE_CTOR(Initializer);
}; };
/** @}*/
} //namespace } //namespace
#ifdef __cplusplus #ifdef __cplusplus

7
inc/thorvg_capi.h
View file

@ -38,6 +38,12 @@ typedef struct _Tvg_Canvas Tvg_Canvas;
typedef struct _Tvg_Paint Tvg_Paint; typedef struct _Tvg_Paint Tvg_Paint;
typedef struct _Tvg_Gradient Tvg_Gradient; typedef struct _Tvg_Gradient Tvg_Gradient;
/**
* \defgroup ThorVGCapi C APIs
*/
/**@{*/
/*! /*!
* \def TVG_ENGINE_SW * \def TVG_ENGINE_SW
* Software raster engine type. * Software raster engine type.
@ -1299,6 +1305,7 @@ TVG_EXPORT Tvg_Result tvg_scene_push(Tvg_Paint* scene, Tvg_Paint* paint);
*/ */
TVG_EXPORT Tvg_Result tvg_scene_clear(Tvg_Paint* scene); TVG_EXPORT Tvg_Result tvg_scene_clear(Tvg_Paint* scene);
/** \}*/
#ifdef __cplusplus #ifdef __cplusplus
} }