Improve documentation

diff --git a/src/sbuf/SBufStringConvert.h b/src/sbuf/SBufStringConvert.h
index 15434f1534d2454efe66babcbde30e65dbb72bee..4b738f1e8d36fc2a342ad3b43c3579e466e64f31 100644 (file)
--- a/src/sbuf/SBufStringConvert.h
+++ b/src/sbuf/SBufStringConvert.h
@@ -12,14 +12,16 @@
 #include "SBuf.h"
 #include "SquidString.h"
 
-/// create a new SBuf from a String
+/// create a new SBuf from a String by copying contents
 inline SBuf
 StringToSBuf(const String &s)
 {
     return SBuf(s.rawBuf(), s.size());
 }
 
-/// create a new String from a SBuf
+/** create a new String from a SBuf by copying contents
+ * \deprecated
+ */
 inline String
 SBufToString(const SBuf &s)
 {