doc: keep the style clean & neat

This commit is contained in:
Hermet Park 2023-11-03 23:53:50 +09:00
parent 40ff8592e5
commit 2c382e3d9b
2 changed files with 26 additions and 26 deletions

View file

@ -186,7 +186,7 @@ enum class CompositeMethod
* *
* @see Paint::blend() * @see Paint::blend()
* *
* @note: Experimental API * @note Experimental API
*/ */
enum class BlendMethod : uint8_t enum class BlendMethod : uint8_t
{ {
@ -248,7 +248,7 @@ struct Matrix
* @param pt The vertex coordinate * @param pt The vertex coordinate
* @param uv The normalized texture coordinate in the range (0.0..1.0, 0.0..1.0) * @param uv The normalized texture coordinate in the range (0.0..1.0, 0.0..1.0)
* *
* @note: Experimental API * @note Experimental API
*/ */
struct Vertex struct Vertex
{ {
@ -262,7 +262,7 @@ struct Vertex
* *
* @param vertex The three vertices that make up the polygon * @param vertex The three vertices that make up the polygon
* *
* @note: Experimental API * @note Experimental API
*/ */
struct Polygon struct Polygon
{ {
@ -374,7 +374,7 @@ public:
* *
* @return Result::Success when the blending method is successfully set. * @return Result::Success when the blending method is successfully set.
* *
* @note: Experimental API * @note Experimental API
*/ */
Result blend(BlendMethod method) const noexcept; Result blend(BlendMethod method) const noexcept;
@ -443,7 +443,7 @@ public:
* *
* @return The blending method * @return The blending method
* *
* @note: Experimental API * @note Experimental API
*/ */
BlendMethod blend() const noexcept; BlendMethod blend() const noexcept;
@ -601,7 +601,7 @@ public:
* @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
*/ */
std::list<Paint*>& paints() noexcept; std::list<Paint*>& paints() noexcept;
@ -1340,7 +1340,7 @@ public:
* @note The Polygons are copied internally, so modifying them after calling Mesh::mesh has no affect. * @note The Polygons are copied internally, so modifying them after calling Mesh::mesh has no affect.
* @warning Please do not use it, this API is not official one. It could be modified in the next version. * @warning Please do not use it, this API is not official one. It could be modified in the next version.
* *
* @note: Experimental API * @note Experimental API
*/ */
Result mesh(const Polygon* triangles, uint32_t triangleCnt) noexcept; Result mesh(const Polygon* triangles, uint32_t triangleCnt) noexcept;
@ -1354,7 +1354,7 @@ public:
* @note Modifying the triangles returned by this method will modify them directly within the mesh. * @note Modifying the triangles returned by this method will modify them directly within the mesh.
* @warning Please do not use it, this API is not official one. It could be modified in the next version. * @warning Please do not use it, this API is not official one. It could be modified in the next version.
* *
* @note: Experimental API * @note Experimental API
*/ */
uint32_t mesh(const Polygon** triangles) const noexcept; uint32_t mesh(const Polygon** triangles) const noexcept;
@ -1433,7 +1433,7 @@ public:
* @see Scene::push() * @see Scene::push()
* @see Scene::clear() * @see Scene::clear()
* *
* @note: Experimental API * @note Experimental API
*/ */
std::list<Paint*>& paints() noexcept; std::list<Paint*>& paints() noexcept;
@ -1565,7 +1565,7 @@ public:
* *
* @warning Please do not use it. This class is not fully supported yet. * @warning Please do not use it. This class is not fully supported yet.
* *
* @note: Experimental API * @note Experimental API
*/ */
class TVG_API GlCanvas final : public Canvas class TVG_API GlCanvas final : public Canvas
{ {
@ -1577,7 +1577,7 @@ public:
* *
* @warning Please do not use it, this API is not official one. It could be modified in the next version. * @warning Please do not use it, this API is not official one. It could be modified in the next version.
* *
* @note: Experimental API * @note Experimental API
*/ */
Result target(uint32_t* buffer, uint32_t stride, uint32_t w, uint32_t h) noexcept; Result target(uint32_t* buffer, uint32_t stride, uint32_t w, uint32_t h) noexcept;
@ -1586,7 +1586,7 @@ public:
* *
* @return A new GlCanvas object. * @return A new GlCanvas object.
* *
* @note: Experimental API * @note Experimental API
*/ */
static std::unique_ptr<GlCanvas> gen() noexcept; static std::unique_ptr<GlCanvas> gen() noexcept;
@ -1601,7 +1601,7 @@ public:
* *
* @warning Please do not use it. This class is not fully supported yet. * @warning Please do not use it. This class is not fully supported yet.
* *
* @note: Experimental API * @note Experimental API
*/ */
class TVG_API WgCanvas final : public Canvas class TVG_API WgCanvas final : public Canvas
{ {
@ -1613,7 +1613,7 @@ public:
* *
* @warning Please do not use it, this API is not official one. It could be modified in the next version. * @warning Please do not use it, this API is not official one. It could be modified in the next version.
* *
* @note: Experimental API * @note Experimental API
*/ */
Result target(void* window, uint32_t w, uint32_t h) noexcept; Result target(void* window, uint32_t w, uint32_t h) noexcept;
@ -1622,7 +1622,7 @@ public:
* *
* @return A new WgCanvas object. * @return A new WgCanvas object.
* *
* @note: Experimental API * @note Experimental API
*/ */
static std::unique_ptr<WgCanvas> gen() noexcept; static std::unique_ptr<WgCanvas> gen() noexcept;
@ -1687,7 +1687,7 @@ public:
* *
* This class supports the display and control of animation frames. * This class supports the display and control of animation frames.
* *
* @note: Experimental API * @note Experimental API
*/ */
class TVG_API Animation class TVG_API Animation
@ -1706,7 +1706,7 @@ public:
* *
* @see totalFrame() * @see totalFrame()
* *
* @note: Experimental API * @note Experimental API
*/ */
Result frame(float no) noexcept; Result frame(float no) noexcept;
@ -1721,7 +1721,7 @@ public:
* *
* @warning The picture instance is owned by Animation. It should not be deleted manually. * @warning The picture instance is owned by Animation. It should not be deleted manually.
* *
* @note: Experimental API * @note Experimental API
*/ */
Picture* picture() const noexcept; Picture* picture() const noexcept;
@ -1735,7 +1735,7 @@ public:
* @see Animation::frame(float no) * @see Animation::frame(float no)
* @see Animation::totalFrame() * @see Animation::totalFrame()
* *
* @note: Experimental API * @note Experimental API
*/ */
float curFrame() const noexcept; float curFrame() const noexcept;
@ -1747,7 +1747,7 @@ public:
* @note Frame numbering starts from 0. * @note Frame numbering starts from 0.
* @note If the Picture is not properly configured, this function will return 0. * @note If the Picture is not properly configured, this function will return 0.
* *
* @note: Experimental API * @note Experimental API
*/ */
float totalFrame() const noexcept; float totalFrame() const noexcept;
@ -1758,7 +1758,7 @@ public:
* *
* @note If the Picture is not properly configured, this function will return 0. * @note If the Picture is not properly configured, this function will return 0.
* *
* @note: Experimental API * @% Experimental API
*/ */
float duration() const noexcept; float duration() const noexcept;
@ -1767,7 +1767,7 @@ public:
* *
* @return A new Animation object. * @return A new Animation object.
* *
* @note: Experimental API * @note Experimental API
*/ */
static std::unique_ptr<Animation> gen() noexcept; static std::unique_ptr<Animation> gen() noexcept;
@ -1842,7 +1842,7 @@ public:
* *
* @see Saver::sync() * @see Saver::sync()
* *
* @note: Experimental API * @note Experimental API
*/ */
Result save(std::unique_ptr<Animation> animation, const std::string& path, uint32_t quality = 100, uint32_t fps = 0) noexcept; Result save(std::unique_ptr<Animation> animation, const std::string& path, uint32_t quality = 100, uint32_t fps = 0) noexcept;

View file

@ -146,7 +146,7 @@ typedef enum {
* *
* \ingroup ThorVGCapi_Paint * \ingroup ThorVGCapi_Paint
* *
* @note: Experimental API * @note Experimental API
*/ */
typedef enum { typedef enum {
TVG_BLEND_METHOD_NORMAL = 0, ///< Perform the alpha blending(default). S if (Sa == 255), otherwise (Sa * S) + (255 - Sa) * D TVG_BLEND_METHOD_NORMAL = 0, ///< Perform the alpha blending(default). S if (Sa == 255), otherwise (Sa * S) + (255 - Sa) * D
@ -983,7 +983,7 @@ TVG_API Tvg_Result tvg_paint_get_identifier(const Tvg_Paint* paint, Tvg_Identifi
* \return Tvg_Result enumeration. * \return Tvg_Result enumeration.
* \retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument. * \retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
* *
* @note: Experimental API * @note Experimental API
*/ */
TVG_API Tvg_Result tvg_paint_set_blend_method(const Tvg_Paint* paint, Tvg_Blend_Method method); TVG_API Tvg_Result tvg_paint_set_blend_method(const Tvg_Paint* paint, Tvg_Blend_Method method);
@ -1001,7 +1001,7 @@ TVG_API Tvg_Result tvg_paint_set_blend_method(const Tvg_Paint* paint, Tvg_Blend_
* \return Tvg_Result enumeration. * \return Tvg_Result enumeration.
* \retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument. * \retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
* *
* @note: Experimental API * @note Experimental API
*/ */
TVG_API Tvg_Result tvg_paint_get_blend_method(const Tvg_Paint* paint, Tvg_Blend_Method* method); TVG_API Tvg_Result tvg_paint_get_blend_method(const Tvg_Paint* paint, Tvg_Blend_Method* method);