From: Francesco Chemolli <kinkie@squid-cache.org>
Date: Thu, 25 Feb 2016 16:34:29 +0000 (+0100)
Subject: Improve documentation
X-Git-Tag: SQUID_4_0_8~60^2~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=97039c686869096f12c1216727eed67dc8ec4197;p=thirdparty%2Fsquid.git

Improve documentation
---

diff --git a/src/sbuf/SBufStringConvert.h b/src/sbuf/SBufStringConvert.h
index 15434f1534..4b738f1e8d 100644
--- 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)
 {