From 2d5ea0bf2c6572cea90a7c9b1482438d4a03c2e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=91=D1=80=D0=B0=D0=BD=D0=B8=D0=BC=D0=B8=D1=80=20=D0=9A?= =?UTF-8?q?=D0=B0=D1=80=D0=B0=D1=9F=D0=B8=D1=9B?= Date: Thu, 21 Feb 2019 20:18:51 -0800 Subject: [PATCH] Cleanup. --- include/bx/string.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/include/bx/string.h b/include/bx/string.h index 6ce98bc..3fdce89 100644 --- a/include/bx/string.h +++ b/include/bx/string.h @@ -21,6 +21,7 @@ namespace bx }; /// Non-zero-terminated string view. + /// class StringView { public: @@ -77,9 +78,16 @@ namespace bx /// void clear(); + /// Returns pointer to non-terminated string. + /// + /// @attention Use of this pointer in standard C/C++ functions is not safe. You must use it + /// in conjunction with `getTerm()` or getLength()`. /// const char* getPtr() const; + /// Returns pointer past last character in string view. + /// + /// @attention Dereferencing this pointer is not safe. /// const char* getTerm() const;