Add missing note to core::path::begin

2023-02-19 14:24:17 +00:00 · 2023-02-19 14:24:17 +00:00 · e64013f03b
commit e64013f03b
parent 811176ad53
1 changed files with 2 additions and 0 deletions
--- a/source/core/files.cpp
+++ b/source/core/files.cpp
@ -29,6 +29,8 @@ export namespace core {

 		/**
 		 * Returns the base pointer of the path name.
+		 *
+		 * *Note*: the returned buffer pointer is guaranteed to end with a zero terminator.
 		 */
 		char const * begin() const {
 			return reinterpret_cast<char const *>(this->buffer);