libcmap_find_{block,script}: clarify relationship, of the return value, to libcmap_{block,script}_list

Signed-off-by: Mattias Andrée <m@maandree.se>

1 files changed, 6 insertions, 0 deletions

diff --git a/libcmap.h b/libcmap.h
index a04b38e..2d249c6 100644
--- a/libcmap.h
+++ b/libcmap.h
@@ -196,6 +196,9 @@ int libcmap_find_in_no_block(uint32_t codepoint, size_t *offset_out, size_t *sub
  * 
  * If `NULL` is returned, *offset_out` will not be set
  * 
+ * The returned pointer (unless `NULL`) is `&libcmap_block_list[i]`
+ * for some non-negative `i` less than `libcmap_block_list_size`
+ * 
  * @seealso  libcmap_find_in_no_block
  * @seealso  libcmap_find_script
  */
@@ -222,6 +225,9 @@ const struct libcmap_block *libcmap_find_block(uint32_t codepoint, size_t *offse
  * 
  * If 0 is returned, `*offset_out` and `*subrange_out` will not be set
  * 
+ * The returned pointer (unless `NULL`) is `&libcmap_script_list[i]`
+ * for some non-negative `i` less than `libcmap_script_list_size`
+ * 
  * @seealso  libcmap_find_block
  */
 const struct libcmap_script *libcmap_find_script(uint32_t codepoint, size_t *offset_out, size_t *subrange_out);