From a40f299a7bd74597bc54cae7264b5a45b9ec11b9 Mon Sep 17 00:00:00 2001
From: Grigori Goronzy <greg@blackbox>
Date: Fri, 24 Jul 2009 10:17:56 +0200
Subject: Document ass_hinting enum

Add a note to the docs regarding hinting method choice.
---
 libass/ass.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/libass/ass.h b/libass/ass.h
index 3c8c1f6..e243711 100644
--- a/libass/ass.h
+++ b/libass/ass.h
@@ -51,7 +51,13 @@ typedef struct ass_image_s {
     struct ass_image_s *next;   // Next image, or NULL
 } ass_image_t;
 
-/* Hinting type. */
+/*
+ * Hintint type. (see ass_set_hinting below)
+ *
+ * FreeType's native hinter is still buggy sometimes and it is recommended
+ * to use the light autohinter, ASS_HINTING_LIGHT, instead.  For best
+ * compatibility with problematic fonts, disable hinting.
+ */
 typedef enum {
     ASS_HINTING_NONE = 0,
     ASS_HINTING_LIGHT,
-- 
cgit v1.2.3