Cleanup: comments (long lines) in blenlib
[blender.git] / source / blender / blenlib / intern / freetypefont.c
index a8b8f01..92553ae 100644 (file)
@@ -497,7 +497,7 @@ VChar *BLI_vfontchar_copy(const VChar *vchar_src, const int UNUSED(flag))
   return vchar_dst;
 }
 
-/*
+/**
  * from: http://www.freetype.org/freetype2/docs/glyphs/glyphs-6.html#section-1
  *
  * Vectorial representation of Freetype glyphs
@@ -508,27 +508,30 @@ VChar *BLI_vfontchar_copy(const VChar *vchar_src, const int UNUSED(flag))
  * they come from the TrueType format. The latter are called cubic arcs and mostly come from the
  * Type1 format.
  *
- * Each arc is described through a series of start, end and control points. Each point of the outline
- * has a specific tag which indicates whether it is used to describe a line segment or an arc.
+ * Each arc is described through a series of start, end and control points.
+ * Each point of the outline has a specific tag which indicates whether it is
+ * used to describe a line segment or an arc.
  * The following rules are applied to decompose the contour's points into segments and arcs :
  *
  * # two successive "on" points indicate a line segment joining them.
  *
- * # one conic "off" point amidst two "on" points indicates a conic bezier arc, the "off" point being
- *   the control point, and the "on" ones the start and end points.
+ * # one conic "off" point amidst two "on" points indicates a conic bezier arc,
+ *   the "off" point being the control point, and the "on" ones the start and end points.
  *
- * # Two successive cubic "off" points amidst two "on" points indicate a cubic bezier arc. There must
- *   be exactly two cubic control points and two on points for each cubic arc (using a single cubic
- *   "off" point between two "on" points is forbidden, for example).
+ * # Two successive cubic "off" points amidst two "on" points indicate a cubic bezier arc.
+ *   There must be exactly two cubic control points and two on points for each cubic arc
+ *   (using a single cubic "off" point between two "on" points is forbidden, for example).
  *
- * # finally, two successive conic "off" points forces the rasterizer to create (during the scan-line
- *   conversion process exclusively) a virtual "on" point amidst them, at their exact middle. This
- *   greatly facilitates the definition of successive conic bezier arcs. Moreover, it's the way
- *   outlines are described in the TrueType specification.
+ * # finally, two successive conic "off" points forces the rasterizer to create
+ *   (during the scan-line conversion process exclusively) a virtual "on" point amidst them,
+ *   at their exact middle.
+ *   This greatly facilitates the definition of successive conic bezier arcs.
+ *   Moreover, it's the way outlines are described in the TrueType specification.
  *
  * Note that it is possible to mix conic and cubic arcs in a single contour, even though no current
  * font driver produces such outlines.
  *
+ * <pre>
  *                                   *            # on
  *                                                * off
  *                                __---__
@@ -560,9 +563,11 @@ VChar *BLI_vfontchar_copy(const VChar *vchar_src, const int UNUSED(flag))
  *      Two "on" points
  *    and two "cubic" point
  *       between them
- * Each glyph's original outline points are located on a grid of indivisible units. The points are stored
- * in the font file as 16-bit integer grid coordinates, with the grid origin's being at (0, 0); they thus
- * range from -16384 to 16383.
+ * </pre>
+ *
+ * Each glyph's original outline points are located on a grid of indivisible units.
+ * The points are stored in the font file as 16-bit integer grid coordinates,
+ * with the grid origin's being at (0, 0); they thus range from -16384 to 16383.
  *
  * Convert conic to bezier arcs:
  * Conic P0 P1 P2