[PATCH] gdiplus: Write API doc for GdipAddPathEllipse and GdipAddPathEllipseI

Clemens Tamme clemens.tamme at gmail.com
Wed Jun 21 15:24:58 CDT 2017


This is a pure API patch. A documentation is written for
GdipAddPathEllipse and GdipAddPathEllipseI in graphicspath.c
The documentation of GdipAddPathEllipseI referes to the one of
GdipAddPathEllipse.

Signed-off-by: Clemens Tamme <clemens.tamme at gmail.com>
---
 dlls/gdiplus/graphicspath.c | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/dlls/gdiplus/graphicspath.c b/dlls/gdiplus/graphicspath.c
index e34f4ed..50bafae 100644
--- a/dlls/gdiplus/graphicspath.c
+++ b/dlls/gdiplus/graphicspath.c
@@ -549,6 +549,32 @@ GpStatus WINGDIPAPI GdipAddPathCurve3I(GpPath *path, GDIPCONST GpPoint *points,
     return GdipAddPathCurve2I(path, &points[offset], nseg + 1, tension);
 }
 
+/*******************************************************************************
+ * GdipAddPathEllipse   [GDIPLUS.17]
+ *
+ * Add an ellipse as a subpath to the given path.
+ *
+ * PARAMS
+ *  path   [I/O] The path that the ellipse is appended to
+ *  x      [I]   The x coordinate of the boundary box
+ *  y      [I]   The y coordinate of the boundary box
+ *  width  [I]   The width of the boundary box
+ *  height [I]   The height of the boundary box
+ *
+ * RETURNS
+ *  InvalidParameter If the given path is invalid
+ *  OutOfMemory      If memory allocation fails
+ *  GenericError     If conversion from arc to bezier curve fails
+ *  Ok               If ecerything works out as expected
+ *
+ * NOTES
+ *  As an ellipse is always a new subpath the current subpath of the given path
+ *  cannot be continued afterwards. Additionally, the next thing added to the
+ *  path will be the start of the next subpath.
+ *
+ *  As seen in the return values, the ellipse is represented as a bezier curve
+ *  in the path.
+ */
 GpStatus WINGDIPAPI GdipAddPathEllipse(GpPath *path, REAL x, REAL y, REAL width,
     REAL height)
 {
@@ -581,6 +607,11 @@ GpStatus WINGDIPAPI GdipAddPathEllipse(GpPath *path, REAL x, REAL y, REAL width,
     return Ok;
 }
 
+/*******************************************************************************
+ * GdipAddPathEllipseI   [GDIPLUS.18]
+ *
+ * See GdipAddPathEllipse
+ */
 GpStatus WINGDIPAPI GdipAddPathEllipseI(GpPath *path, INT x, INT y, INT width,
     INT height)
 {
-- 
2.7.4




More information about the wine-patches mailing list