Changeset 831 in MondoRescue for branches/stable/mondo/mondo/common/mr_string.c

Timestamp:

Sep 25, 2006, 1:07:16 PM (18 years ago)

Author:

andree

Message:

Add new header mr_string.h for mr_string.c. Use mr_strtok() from
mr_string.c and delete from libmondo-string.c. Add mr_string.c and
mr_string.h to Makefile.am. (Follow-up to r828.)

File:

• branches/stable/mondo/mondo/common/mr_string.c (modified) (2 diffs)

branches/stable/mondo/mondo/common/mr_string.c

@@ -1 @@
-// New generation of string handling functions
+/*
+ * mr_string.c - New generation of string handling functions
+ */
 
-
-// Safe alternative to standard function strok()
+#include <stdio.h>
+#include <string.h>
+ 
+/**
+ * Safe alternative to standard function strok()
+ * @param instr
+ * @param delims
+ * @param lastpos
+ * @return @p
+ * @note this function allocates memory that needs to be freed by caller
+ **/
 char *mr_strtok(char *instr, const char *delims, int *lastpos)
 {
@@ -29 +40 @@
 
 
-// Returns the string fed to it 'inptr' with all characters to escape given
-// in 'toesc' prepended by escaping character 'escchr'.
-// (Prepare strings for use in system() or popen() with this function.)
+/**
+ * Returns the string fed to it 'inptr' with all characters to escape given
+ * in 'toesc' prepended by escaping character 'escchr'.
+ * (Prepare strings for use in system() or popen() with this function.)
+ * @param instr
+ * @param toesc
+ * @param escchr
+ * @note this function allocates memory that needs to be freed by caller
+ **/
 char *mr_stresc(char *instr, char *toesc, const char escchr)
 {