Write @arg instead of @param arg in doc comments

1 files changed, 52 insertions, 52 deletions

diff --git a/src/dstring.h b/src/dstring.h
index 79458e4..f7afcf7 100644
--- a/src/dstring.h
+++ b/src/dstring.h
@@ -31,7 +31,7 @@ typedef char dchar;
 /**
  * Free a dynamic string.
  *
- * @param dstr
+ * @dstr
  *         The string to free.
  */
 void dstrfree(dchar *dstr);
@@ -39,7 +39,7 @@ void dstrfree(dchar *dstr);
 /**
  * Allocate a dynamic string.
  *
- * @param cap
+ * @cap
  *         The initial capacity of the string.
  */
 _malloc(dstrfree, 1)
@@ -48,7 +48,7 @@ dchar *dstralloc(size_t cap);
 /**
  * Create a dynamic copy of a string.
  *
- * @param str
+ * @str
  *         The NUL-terminated string to copy.
  */
 _malloc(dstrfree, 1)
@@ -57,9 +57,9 @@ dchar *dstrdup(const char *str);
 /**
  * Create a length-limited dynamic copy of a string.
  *
- * @param str
+ * @str
  *         The string to copy.
- * @param n
+ * @n
  *         The maximum number of characters to copy from str.
  */
 _malloc(dstrfree, 1)
@@ -68,7 +68,7 @@ dchar *dstrndup(const char *str, size_t n);
 /**
  * Create a dynamic copy of a dynamic string.
  *
- * @param dstr
+ * @dstr
  *         The dynamic string to copy.
  */
 _malloc(dstrfree, 1)
@@ -77,9 +77,9 @@ dchar *dstrddup(const dchar *dstr);
 /**
  * Create an exact-sized dynamic copy of a string.
  *
- * @param str
+ * @str
  *         The string to copy.
- * @param len
+ * @len
  *         The length of the string, which may include internal NUL bytes.
  */
 _malloc(dstrfree, 1)
@@ -88,7 +88,7 @@ dchar *dstrxdup(const char *str, size_t len);
 /**
  * Get a dynamic string's length.
  *
- * @param dstr
+ * @dstr
  *         The string to measure.
  * @return
  *         The length of dstr.
@@ -98,9 +98,9 @@ size_t dstrlen(const dchar *dstr);
 /**
  * Reserve some capacity in a dynamic string.
  *
- * @param dstr
+ * @dstr
  *         The dynamic string to preallocate.
- * @param cap
+ * @cap
  *         The new capacity for the string.
  * @return
  *         0 on success, -1 on failure.
@@ -110,9 +110,9 @@ int dstreserve(dchar **dstr, size_t cap);
 /**
  * Resize a dynamic string.
  *
- * @param dstr
+ * @dstr
  *         The dynamic string to resize.
- * @param len
+ * @len
  *         The new length for the dynamic string.
  * @return
  *         0 on success, -1 on failure.
@@ -122,9 +122,9 @@ int dstresize(dchar **dstr, size_t len);
 /**
  * Append to a dynamic string.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param src
+ * @src
  *         The string to append.
  * @return 0 on success, -1 on failure.
  */
@@ -133,11 +133,11 @@ int dstrcat(dchar **dest, const char *src);
 /**
  * Append to a dynamic string.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param src
+ * @src
  *         The string to append.
- * @param n
+ * @n
  *         The maximum number of characters to take from src.
  * @return
  *         0 on success, -1 on failure.
@@ -147,9 +147,9 @@ int dstrncat(dchar **dest, const char *src, size_t n);
 /**
  * Append a dynamic string to another dynamic string.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param src
+ * @src
  *         The dynamic string to append.
  * @return
  *         0 on success, -1 on failure.
@@ -159,11 +159,11 @@ int dstrdcat(dchar **dest, const dchar *src);
 /**
  * Append to a dynamic string.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param src
+ * @src
  *         The string to append.
- * @param len
+ * @len
  *         The exact number of characters to take from src.
  * @return
  *         0 on success, -1 on failure.
@@ -173,9 +173,9 @@ int dstrxcat(dchar **dest, const char *src, size_t len);
 /**
  * Append a single character to a dynamic string.
  *
- * @param str
+ * @str
  *         The string to append to.
- * @param c
+ * @c
  *         The character to append.
  * @return
  *         0 on success, -1 on failure.
@@ -185,9 +185,9 @@ int dstrapp(dchar **str, char c);
 /**
  * Copy a string into a dynamic string.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param src
+ * @src
  *         The string to copy.
  * @returns
  *         0 on success, -1 on failure.
@@ -197,9 +197,9 @@ int dstrcpy(dchar **dest, const char *str);
 /**
  * Copy a dynamic string into another one.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param src
+ * @src
  *         The dynamic string to copy.
  * @returns
  *         0 on success, -1 on failure.
@@ -209,11 +209,11 @@ int dstrdcpy(dchar **dest, const dchar *str);
 /**
  * Copy a string into a dynamic string.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param src
+ * @src
  *         The dynamic string to copy.
- * @param n
+ * @n
  *         The maximum number of characters to take from src.
  * @returns
  *         0 on success, -1 on failure.
@@ -223,11 +223,11 @@ int dstrncpy(dchar **dest, const char *str, size_t n);
 /**
  * Copy a string into a dynamic string.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param src
+ * @src
  *         The dynamic string to copy.
- * @param len
+ * @len
  *         The exact number of characters to take from src.
  * @returns
  *         0 on success, -1 on failure.
@@ -237,9 +237,9 @@ int dstrxcpy(dchar **dest, const char *str, size_t len);
 /**
  * Create a dynamic string from a format string.
  *
- * @param format
+ * @format
  *         The format string to fill in.
- * @param ...
+ * @...
  *         Any arguments for the format string.
  * @return
  *         The created string, or NULL on failure.
@@ -250,9 +250,9 @@ dchar *dstrprintf(const char *format, ...);
 /**
  * Create a dynamic string from a format string and a va_list.
  *
- * @param format
+ * @format
  *         The format string to fill in.
- * @param args
+ * @args
  *         The arguments for the format string.
  * @return
  *         The created string, or NULL on failure.
@@ -263,11 +263,11 @@ dchar *dstrvprintf(const char *format, va_list args);
 /**
  * Format some text onto the end of a dynamic string.
  *
- * @param str
+ * @str
  *         The destination dynamic string.
- * @param format
+ * @format
  *         The format string to fill in.
- * @param ...
+ * @...
  *         Any arguments for the format string.
  * @return
  *         0 on success, -1 on failure.
@@ -278,11 +278,11 @@ int dstrcatf(dchar **str, const char *format, ...);
 /**
  * Format some text from a va_list onto the end of a dynamic string.
  *
- * @param str
+ * @str
  *         The destination dynamic string.
- * @param format
+ * @format
  *         The format string to fill in.
- * @param args
+ * @args
  *         The arguments for the format string.
  * @return
  *         0 on success, -1 on failure.
@@ -293,11 +293,11 @@ int dstrvcatf(dchar **str, const char *format, va_list args);
 /**
  * Concatenate while shell-escaping.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param str
+ * @str
  *         The string to escape.
- * @param flags
+ * @flags
  *         Flags for wordesc().
  * @return
  *         0 on success, -1 on failure.
@@ -307,13 +307,13 @@ int dstrescat(dchar **dest, const char *str, enum wesc_flags flags);
 /**
  * Concatenate while shell-escaping.
  *
- * @param dest
+ * @dest
  *         The destination dynamic string.
- * @param str
+ * @str
  *         The string to escape.
- * @param n
+ * @n
  *         The maximum length of the string.
- * @param flags
+ * @flags
  *         Flags for wordesc().
  * @return
  *         0 on success, -1 on failure.