Changeset 1791 for code/trunk/src/util/String.cc

Timestamp:

Sep 16, 2008, 3:46:25 AM (16 years ago)

Author:

landauf

Message:

added comments to all my classes in util

File:

• code/trunk/src/util/String.cc (modified) (4 diffs)

code/trunk/src/util/String.cc

@@ -27 +27 @@
  */
 
+/**
+    @file String.cc
+    @brief Implementation of several string manipulation functions.
+*/
+
 #include "String.h"
 
@@ -33 +38 @@
 
 /**
-    @brief Blank string as variable so you can use const std::string& even
-           if you have to return "".
+    @brief Blank string as variable so you can use const std::string& even if you have to return "".
 */
 std::string blankString = "";
@@ -273 +277 @@
 }
 
+/**
+    @brief Adds backslashes to the given string which makes special chars visible. Existing slashes will be doubled.
+    @param str The string to manipulate
+    @return The string with added slashes
+*/
 std::string addSlashes(const std::string& str)
 {
@@ -291 +300 @@
 }
 
+/**
+    @brief Removes backslashes from the given string. Double backslashes are interpreted as one backslash.
+    @param str The string to manipulate
+    @return The string with removed slashes
+*/
 std::string removeSlashes(const std::string& str)
 {