Changeset 7707 for trunk/psLib/src/sys/psString.h

Timestamp:

Jun 27, 2006, 10:33:22 AM (20 years ago)

Author:

drobbin

Message:

Edited doxygen in psString.h. Updated tests (for removal of p_psTimeFromTM and psTimeToISO 1999-01-01T00:00:60 = 1998-12-31T23:59:60)

File:

• trunk/psLib/src/sys/psString.h (modified) (2 diffs)

trunk/psLib/src/sys/psString.h

@@ -14 +14 @@
  *  @author David Robbins, MHPCC
  *
- *  @version $Revision: 1.23 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-06-23 20:29:39 $
+ *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-06-27 20:33:22 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -103 +103 @@
  */
 psList *psStringSplit(
-    const char *string,
-    const char *splitters,
-    bool multipleAreSignificant
+    const char *string,                ///< String to split
+    const char *splitters,             ///< Characters on which to split
+    bool multipleAreSignificant        ///< Are multiple occurences significant?
 );
 
-// Same as psStringSplit, but return result as an array
-psArray *psStringSplitArray(const char *string, // String to split
-                            const char *splitters, // Characters on which to split
-                            bool multipleAreSignificant // Are multiple occurences significant?
-                           );
+/** Procedure to split the input string into a psArray of psStrings.
+ *
+ *  The string is split at any one of the characters in splitters.  Split
+ *  strings of zero length should not be included in the output list.
+ *
+ *  @return psArray*:       The array of (split) psStrings.
+ */
+psArray *psStringSplitArray(
+    const char *string,                ///< String to split
+    const char *splitters,             ///< Characters on which to split
+    bool multipleAreSignificant        ///< Are multiple occurences significant?
+);
 
 // Given the input string, search for all copies of the key, and replace with the replacement value
 // the input string may be freed if not needed
-char *psStringSubstitute (char *input,  ///< input string to be modified
-                          const char *replace, ///< replacement value
-                          const char *key ///< string to be replaced in input
-                         );
+/** Procedure to search an input string and substitute strings where desired.
+ *
+ *  The input string is searched for all instances of the key, which is then replaced with
+ *  the replacement value wherever found.  The input string may be freed if not needed.
+ *
+ *  @return char*:      the modified input string.
+ */
+char *psStringSubstitute (
+    char *input,                       ///< input string to be modified
+    const char *replace,               ///< replacement value
+    const char *key                    ///< string to be replaced in input
+);
 
 // strip whitespace from head and tail of string
-size_t psStringStrip(char *string);
+/** Procedure to strip the whitespace from the head and tail of a string.
+ *
+ *  @return size_t:         Number of whitespaces removed.
+ */
+size_t psStringStrip(
+    char *string                       ///< input string to be stripped.
+);