From 1d357adfa19725ee69fb267a363f1fd217b1272f Mon Sep 17 00:00:00 2001
From: Dominick Allen <djallen@librehumanitas.org>
Date: Sat, 4 Jan 2025 12:02:45 -0600
Subject: Various style fixes.

---
 include/fud_string_view.hpp | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'include/fud_string_view.hpp')

diff --git a/include/fud_string_view.hpp b/include/fud_string_view.hpp
index d8f67ba..f71919d 100644
--- a/include/fud_string_view.hpp
+++ b/include/fud_string_view.hpp
@@ -129,6 +129,11 @@ struct StringView {
         return m_data + m_length;
     }
 
+    /** \brief Checks if one past the length is the null terminator character.
+     *
+     * \par WARNING: This function may invoke UB if the pointer to data plus its
+     *      length does not belong to the data sequence.
+     */
     [[nodiscard]] bool nullTerminated() const;
 
     [[nodiscard]] bool utf8Valid() const;
-- 
cgit v1.2.3