commit 8ab797c5b86c33eab6ee024471fd3c147325d26a
author Khaled Hosny <khaledhosny@eglug.org> Tue Dec 29 17:42:16 2015 +0400
committer Khaled Hosny <khaledhosny@eglug.org> Wed Dec 30 17:59:01 2015 +0400
tree 26d8d645ff250583c7afdbc6ef58da9b0f83ffcb
parent f18d2226b62f20d29e6299c01ae8467c725ea971

[docs] A bit more buffers documentation

src/hb-common.h

diff --git a/src/hb-common.h b/src/hb-common.h
index af17d78..5b0a0b6 100644
--- a/src/hb-common.h
+++ b/src/hb-common.h
@@ -106,8 +106,14 @@
 hb_tag_to_string (hb_tag_t tag, char *buf);
 
 
-/* hb_direction_t */
-
+/**
+ * hb_direction_t:
+ * @HB_DIRECTION_INVALID: Initial, unset direction.
+ * @HB_DIRECTION_LTR: Text is set horizontally from left to right.
+ * @HB_DIRECTION_RTL: Text is set horizontally from right to left.
+ * @HB_DIRECTION_TTB: Text is set vertically from top to bottom.
+ * @HB_DIRECTION_BTT: Text is set vertically from bottom to top.
+ */
 typedef enum {
   HB_DIRECTION_INVALID = 0,
   HB_DIRECTION_LTR = 4,
@@ -136,7 +142,6 @@
 
 typedef const struct hb_language_impl_t *hb_language_t;
 
-/* len=-1 means str is NUL-terminated */
 HB_EXTERN hb_language_t
 hb_language_from_string (const char *str, int len);
 
@@ -327,10 +332,8 @@
 HB_EXTERN hb_script_t
 hb_script_from_iso15924_tag (hb_tag_t tag);
 
-/* sugar for tag_from_string() then script_from_iso15924_tag */
-/* len=-1 means s is NUL-terminated */
 HB_EXTERN hb_script_t
-hb_script_from_string (const char *s, int len);
+hb_script_from_string (const char *str, int len);
 
 HB_EXTERN hb_tag_t
 hb_script_to_iso15924_tag (hb_script_t script);