Date: Thursday, March 1, 2007 @ 16:56:41
  Author: marc
    Path: /cvsroot/carob/carob/include

Modified: StringCodecs.hpp (1.27 -> 1.28)

javadoc


------------------+
 StringCodecs.hpp |   14 ++++++++++----
 1 files changed, 10 insertions(+), 4 deletions(-)


Index: carob/include/StringCodecs.hpp
diff -u carob/include/StringCodecs.hpp:1.27 carob/include/StringCodecs.hpp:1.28
--- carob/include/StringCodecs.hpp:1.27 Tue Jan 30 11:16:52 2007
+++ carob/include/StringCodecs.hpp      Thu Mar  1 16:56:40 2007
@@ -58,7 +58,7 @@
 
 std::locale trylocale(const char * const name) throw (CodecException);
 
-
+/** Base class for en/decoders */
 class StringCodec
 {
 public:
@@ -73,11 +73,17 @@
   /** Optional optimization. Maybe faster method, suitable ONLY for
    * non-concurrent use. Unlike the safe encode() method above, this
    * method may or may not be thread-safe, depending on the actual
-   * codec implementation */
+   * codec implementation
+   * @param s decoded wide string
+   * @return encoded string
+   */
     virtual std::string nomutex_encode(const std::wstring& s) const throw 
(CodecException)
     { return encode(s); }
-  /* Idem above. Calling nomutex_encode() and nomutex_decode() each
-   * only once at the same time is safe */
+    /** See nomutex_encode. Calling nomutex_encode() and
+     * nomutex_decode() each only once at the same time is safe
+     * @param s encoded string
+     * @return decoded wide string
+     */
     virtual std::wstring nomutex_decode(const std::string& s) const throw 
(CodecException)
     { return decode(s); }
 };

_______________________________________________
Carob-commits mailing list
[email protected]
https://forge.continuent.org/mailman/listinfo/carob-commits

Reply via email to