[core] Update srtcore/threadname.h

Co-authored-by: Maxim Sharabayko <maxsharabayko@haivision.com>
Haivision · Aug 4, 2021 · d6f93a1 · d6f93a1
1 parent 73cad8d
commit d6f93a1
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/srtcore/threadname.h b/srtcore/threadname.h
@@ -144,7 +144,10 @@ class ThreadName
     static const bool   DUMMY_IMPL = ThreadNameImpl::DUMMY_IMPL;
     static const size_t BUFSIZE    = ThreadNameImpl::BUFSIZE;
 
-    // len should >= BUFSIZE
+    /// @brief Print thread ID to the provided buffer.
+    /// The size of the destination buffer is assumed to be at least ThreadName::BUFSIZE.
+    /// @param [out] output destination buffer to get thread name
+    /// @return true on success, false on failure
     static bool get(char* output) {
         return ThreadNameImpl::get(output);
     }