Бранимир Караџић 6 years ago
parent
commit
2d5ea0bf2c
1 changed files with 8 additions and 0 deletions
  1. 8 0
      include/bx/string.h

+ 8 - 0
include/bx/string.h

@@ -21,6 +21,7 @@ namespace bx
 	};
 	};
 
 
 	/// Non-zero-terminated string view.
 	/// Non-zero-terminated string view.
+	///
 	class StringView
 	class StringView
 	{
 	{
 	public:
 	public:
@@ -77,9 +78,16 @@ namespace bx
 		///
 		///
 		void clear();
 		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;
 		const char* getPtr() const;
 
 
+		/// Returns pointer past last character in string view.
+		///
+		/// @attention Dereferencing this pointer is not safe.
 		///
 		///
 		const char* getTerm() const;
 		const char* getTerm() const;