[Bf-blender-cvs] [bb6fbc6] master: Docs: scanfill.c purpose

[Campbell Barton]

Commit: bb6fbc64ae2bf4d1cba4a4b6f1831e6df58e2e6b
Author: Campbell Barton
Date:   Fri May 6 00:37:31 2016 +1000
Branches: master
https://developer.blender.org/rBbb6fbc64ae2bf4d1cba4a4b6f1831e6df58e2e6b

Docs: scanfill.c purpose

===================================================================

M	source/blender/blenlib/intern/scanfill.c

===================================================================

diff --git a/source/blender/blenlib/intern/scanfill.c b/source/blender/blenlib/intern/scanfill.c
index e913499..4406a45 100644
--- a/source/blender/blenlib/intern/scanfill.c
+++ b/source/blender/blenlib/intern/scanfill.c
@@ -28,6 +28,15 @@
 
 /** \file blender/blenlib/intern/scanfill.c
  *  \ingroup bli
+ *
+ * Triangulate multiple 2D/3D polygon with support for holes,
+ * use for tessellating curves, fonts and geometry.
+ * See main function #BLI_scanfill_calc
+ *
+ * Uses sweep-line method.
+ *
+ * \note There is a similar API in polyfill2d.c
+ * which uses ear clipping, but has no hole support.
  */
 
 #include <stdio.h>