Trivial typo fixes and cosmetic cleanups.

diff --git a/send_common.c b/send_common.c
index a2189b030b39074778798da96ce91c5e52785ed3..b81600737e441bef40837f23f7e1d877b297b62a 100644 (file)
--- a/send_common.c
+++ b/send_common.c
@@ -443,6 +443,7 @@ out:
 /**
  * Parse a FEC URL string.
  *
+ * \param arg the URL string to parse.
  * \param scd The structure containing host, port and the FEC parameters.
  *
  * \return Standard.

diff --git a/string.c b/string.c
index e037ebb49c75f9a38c42e7699090253a55bef74d..f51f3574f0cf372bdd8febb5ac517c45e3d92d59 100644 (file)
--- a/string.c
+++ b/string.c
@@ -33,7 +33,7 @@
 __must_check __malloc void *para_realloc(void *p, size_t size)
 {
        /*
-        * No need to check for NULL pointers: If p is NULL, the  call
+        * No need to check for NULL pointers: If p is NULL, the call
         * to realloc is equivalent to malloc(size)
         */
        assert(size);
@@ -64,7 +64,7 @@ __must_check __malloc void *para_malloc(size_t size)
        assert(size);
        p = malloc(size);
        if (!p) {
-               PARA_EMERG_LOG("malloc failed (size = %zu),  aborting\n",
+               PARA_EMERG_LOG("malloc failed (size = %zu), aborting\n",
                        size);
                exit(EXIT_FAILURE);
        }
@@ -99,7 +99,7 @@ __must_check __malloc void *para_calloc(size_t size)
  * A wrapper for strdup(3). It calls \p exit(EXIT_FAILURE) on errors, i.e.
  * there is no need to check the return value in the caller.
  *
- * \return A pointer to the duplicated string. If \p s was the NULL pointer,
+ * \return A pointer to the duplicated string. If \a s was the \p NULL pointer,
  * an pointer to an empty string is returned.
  *
  * \sa strdup(3)
@@ -218,12 +218,13 @@ __must_check const char *para_basename(const char *name)
  *
  * \param buf The string to be chopped.
  *
- * Replace the last character in \p buf by zero if it is euqal to
+ * Replace the last character in \p buf by zero if it is equal to
  * the newline character.
  */
 void chop(char *buf)
 {
        int n = strlen(buf);
+
        if (!n)
                return;
        if (buf[n - 1] == '\n')
@@ -234,7 +235,7 @@ void chop(char *buf)
  * Get a random filename.
  *
  * This is by no means a secure way to create temporary files in a hostile
- * direcory like \p /tmp. However, it is OK to use for temp files, fifos,
+ * directory like \p /tmp. However, it is OK to use for temp files, fifos,
  * sockets that are created in ~/.paraslash. Result must be freed by the
  * caller.
  *
@@ -254,8 +255,8 @@ __must_check __malloc char *para_tmpname(void)
 /**
  * Get the logname of the current user.
  *
- * \return A dynammically allocated string that must be freed by the caller. On
- * errors, the string "unknown user" is returned, i.e. this function never
+ * \return A dynamically allocated string that must be freed by the caller. On
+ * errors, the string "unknown_user" is returned, i.e. this function never
  * returns \p NULL.
  *
  * \sa getpwuid(3).
@@ -269,7 +270,7 @@ __must_check __malloc char *para_logname(void)
 /**
  * Get the home directory of the current user.
  *
- * \return A dynammically allocated string that must be freed by the caller. If
+ * \return A dynamically allocated string that must be freed by the caller. If
  * the home directory could not be found, this function returns "/tmp".
  */
 __must_check __malloc char *para_homedir(void)
@@ -285,7 +286,7 @@ __must_check __malloc char *para_homedir(void)
  * \param argv_ptr Pointer to the list of substrings.
  * \param delim Delimiter.
  *
- * This function modifies \a args by replacing each occurance of \a delim by
+ * This function modifies \a args by replacing each occurrence of \a delim by
  * zero. A \p NULL-terminated array of pointers to char* is allocated dynamically
  * and these pointers are initialized to point to the broken-up substrings
  * within \a args. A pointer to this array is returned via \a argv_ptr.
@@ -331,7 +332,7 @@ unsigned split_args(char *args, char *** const argv_ptr, const char *delim)
 /**
  * Get the own hostname.
  *
- * \return A dynammically allocated string containing the hostname.
+ * \return A dynamically allocated string containing the hostname.
  *
  * \sa uname(2).
  */
@@ -408,7 +409,7 @@ static int for_each_complete_line(enum for_each_line_modes mode, char *buf,
 /**
  * Call a custom function for each complete line.
  *
- * \param buf The buffer containing data seperated by newlines.
+ * \param buf The buffer containing data separated by newlines.
  * \param size The number of bytes in \a buf.
  * \param line_handler The custom function.
  * \param private_data Pointer passed to \a line_handler.
@@ -457,7 +458,7 @@ int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler,
 }
 
 /**
- * Safely print into a buffer at a given offset
+ * Safely print into a buffer at a given offset.
  *
  * \param b Determines the buffer, its size, and the offset.
  * \param fmt The format string.
@@ -465,7 +466,7 @@ int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler,
  * This function prints into the buffer given by \a b at the offset which is
  * also given by \a b. If there is not enough space to hold the result, the
  * buffer size is doubled until the underlying call to vsnprintf() succeeds
- * or the size of the buffer exceeds the maximal size specified in \a pb.
+ * or the size of the buffer exceeds the maximal size specified in \a b.
  *
  * In the latter case the unmodified \a buf and \a offset values as well as the
  * private_data pointer of \a b are passed to the \a max_size_handler of \a b.
@@ -481,7 +482,7 @@ int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler,
  * initial buffer is allocated.
  *
  * \return The number of bytes printed into the buffer (not including the
- * therminating \p NULL byte).
+ * terminating \p NULL byte).
  *
  * \sa make_message(), vsnprintf(3).
  */