Add comments to functions that don't NUL-terminate string buffers

2 files changed, 3 insertions, 0 deletions

diff --git a/include/vterm.h b/include/vterm.h
index ee9603c..2c54d14 100644
--- a/include/vterm.h
+++ b/include/vterm.h
@@ -257,6 +257,8 @@ void vterm_screen_flush_damage(VTermScreen *screen);
 void vterm_screen_set_damage_merge(VTermScreen *screen, VTermDamageSize size);
 
 void   vterm_screen_reset(VTermScreen *screen, int hard);
+
+/* Neither of these functions NUL-terminate the buffer */
 size_t vterm_screen_get_chars(const VTermScreen *screen, uint32_t *chars, size_t len, const VTermRect rect);
 size_t vterm_screen_get_text(const VTermScreen *screen, char *str, size_t len, const VTermRect rect);
 
diff --git a/src/utf8.h b/src/utf8.h
index 5bfb413..9a336d3 100644
--- a/src/utf8.h
+++ b/src/utf8.h
@@ -12,6 +12,7 @@ static inline unsigned int utf8_seqlen(long codepoint)
   return 6;
 }
 
+/* Does NOT NUL-terminate the buffer */
 static int fill_utf8(long codepoint, char *str)
 {
   int nbytes = utf8_seqlen(codepoint);