Clemens Tamme : gdiplus: Write API documentation for GdipAddPathArc and GdipAddPathArcI.

[Alexandre Julliard]

Module: wine
Branch: master
Commit: c95877da42c2eb03085edf54a114cd0c766ad184
URL:    http://source.winehq.org/git/wine.git/?a=commit;h=c95877da42c2eb03085edf54a114cd0c766ad184

Author: Clemens Tamme <clemens.tamme at gmail.com>
Date:   Thu Jun 22 18:47:42 2017 +0200

gdiplus: Write API documentation for GdipAddPathArc and GdipAddPathArcI.

Signed-off-by: Clemens Tamme <clemens.tamme at gmail.com>
Signed-off-by: Vincent Povirk <vincent at codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard at winehq.org>

---

 dlls/gdiplus/graphicspath.c | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/dlls/gdiplus/graphicspath.c b/dlls/gdiplus/graphicspath.c
index 815ce34..5fedd07 100644
--- a/dlls/gdiplus/graphicspath.c
+++ b/dlls/gdiplus/graphicspath.c
@@ -166,6 +166,32 @@ static BOOL flatten_bezier(path_list_node_t *start, REAL x2, REAL y2, REAL x3, R
     return TRUE;
 }
 
+/*******************************************************************************
+ * GdipAddPathArc   [GDIPLUS.1]
+ *
+ * Add an elliptical arc to the given path.
+ *
+ * PARAMS
+ *  path       [I/O] Path that the arc is appended to
+ *  x1         [I]   X coordinate of the boundary box
+ *  y1         [I]   Y coordinate of the boundary box
+ *  x2         [I]   Width of the boundary box
+ *  y2         [I]   Height of the boundary box
+ *  startAngle [I]   Starting angle of the arc, clockwise
+ *  sweepAngle [I]   Angle of the arc, clockwise
+ *
+ * RETURNS
+ *  InvalidParameter If the given path is invalid
+ *  OutOfMemory      If memory allocation fails, i.e. the path cannot be lengthened
+ *  Ok               If everything works out as expected
+ *
+ * NOTES
+ *  This functions takes the newfigure value of the given path into account,
+ *  i.e. the arc is connected to the end of the given path if it was set to
+ *  FALSE, otherwise the arc's first point gets the the PathPointTypeStart
+ *  value. In both cases, the value of newfigure of the given path is FALSE
+ *  afterwards.
+ */
 GpStatus WINGDIPAPI GdipAddPathArc(GpPath *path, REAL x1, REAL y1, REAL x2,
     REAL y2, REAL startAngle, REAL sweepAngle)
 {
@@ -200,6 +226,11 @@ GpStatus WINGDIPAPI GdipAddPathArc(GpPath *path, REAL x1, REAL y1, REAL x2,
     return Ok;
 }
 
+/*******************************************************************************
+ * GdipAddPathArcI   [GDUPLUS.2]
+ *
+ * See GdipAddPathArc
+ */
 GpStatus WINGDIPAPI GdipAddPathArcI(GpPath *path, INT x1, INT y1, INT x2,
    INT y2, REAL startAngle, REAL sweepAngle)
 {