Document ass_hinting enum

Add a note to the docs regarding hinting method choice.

diff --git a/libass/ass.h b/libass/ass.h
index 3c8c1f65c20e03f9433b32e6d71b2a99f2ae3144..e2437113756dec9cc3720bcdd1ebb7e550e489e6 100644 (file)
--- 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,