Usermanual, minor: flesh out invisible-glyph discussion in buffers chapter.
authorNathan Willis <nwillis@glyphography.com>
Sat, 11 May 2019 19:56:02 +0000 (20:56 +0100)
committerNathan Willis <nwillis@glyphography.com>
Sat, 11 May 2019 19:56:02 +0000 (20:56 +0100)
docs/usermanual-buffers-language-script-and-direction.xml

index 719b688..b66f270 100644 (file)
       hb_buffer_set_replacement_codepoint(buf, replacement);
     </programlisting>
     <para>
+      passing in the replacement Unicode code point as the
+      <parameter>replacement</parameter> parameter.
+    </para>
+    <para>
       The invisible glyph is used to replace all output glyphs that
       are invisible. By default, the standard space character
       <literal>U+0020</literal> is used; you can replace this (for
       spaces) with 
     </para>
     <programlisting language="C">
-      hb_buffer_set_invisible_glyph(buf, replacement);
+      hb_buffer_set_invisible_glyph(buf, replacement_glyph);
     </programlisting>
     <para>
+      Do note that in the <parameter>replacement_glyph</parameter>
+      parameter, you must provide the glyph ID of the replacement you
+      wish to use, not the Unicode code point.
+    </para>
+    <para>
       HarfBuzz supports a few additional flags you might want to set
       on your buffer under certain circumstances. The
       <literal>HB_BUFFER_FLAG_BOT</literal> and
       property designates control characters and other non-printing
       code points, such as joiners and variation selectors. Normally
       HarfBuzz replaces them in the output buffer with zero-width
-      space glyphs; setting this flag causes them to be printed,
-      which can be helpful for troubleshooting. 
+      space glyphs (using the "invisible glyph" property discussed
+      above); setting this flag causes them to be printed, which can
+      be helpful for troubleshooting.
     </para>
     <para>
       Conversely, setting the
     <para>
       In addition, you can mark your <literal>unicode_funcs</literal>
       as immutable by calling
-      <function>hb_unicode_funcs_make_immutable (ufuncs)</function>. This is especially useful if your code is a
+      <function>hb_unicode_funcs_make_immutable (ufuncs)</function>.
+      This is especially useful if your code is a
       library or framework that will have its own client programs. By
       marking your Unicode function choices as immutable, you prevent
       your own client programs from changing the