Update buffer docs
diff --git a/src/hb-buffer-private.hh b/src/hb-buffer-private.hh
index 2ba4858..b293b96 100644
--- a/src/hb-buffer-private.hh
+++ b/src/hb-buffer-private.hh
@@ -106,13 +106,14 @@
/* Buffer contents */
- unsigned int allocated;
+ unsigned int allocated; /* Length of allocated arrays */
- hb_bool_t have_output; /* whether we have an output buffer going on */
- hb_bool_t have_positions; /* whether we have positions */
- unsigned int len;
- unsigned int out_len;
- unsigned int i;
+ hb_bool_t have_output; /* Whether we have an output buffer going on */
+ hb_bool_t have_positions; /* Whether we have positions */
+
+ unsigned int i; /* Cursor into ->info and ->pos arrays */
+ unsigned int len; /* Length of ->info and ->pos arrays */
+ unsigned int out_len; /* Length of ->out array */
hb_internal_glyph_info_t *info;
hb_internal_glyph_info_t *out_info;
diff --git a/src/hb-buffer.cc b/src/hb-buffer.cc
index 73fbb10..e546def 100644
--- a/src/hb-buffer.cc
+++ b/src/hb-buffer.cc
@@ -38,20 +38,20 @@
/* Here is how the buffer works internally:
*
- * There are two string pointers: info and out_info. They
- * always have same allocated size, but different length and positions.
+ * There are two info pointers: info and out_info. They always have
+ * the same allocated size, but different lengths.
*
* As an optimization, both info and out_info may point to the
* same piece of memory, which is owned by info. This remains the
* case as long as out_len doesn't exceed len at any time.
- * In that case, swap() is no-op and the glyph operations operate mostly
- * in-place.
+ * In that case, swap() is no-op and the glyph operations operate
+ * mostly in-place.
*
* As soon as out_info gets longer than info, out_info is moved over
- * to an alternate buffer (which we reuse the positions buffer for!), and its
- * current contents (out_len entries) are copied to the alt buffer.
- * This should all remain transparent to the user. swap() then switches
- * info and out_info.
+ * to an alternate buffer (which we reuse the pos buffer for!), and its
+ * current contents (out_len entries) are copied to the new place.
+ * This should all remain transparent to the user. swap() then
+ * switches info and out_info.
*/
/* XXX err handling */
