summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Burnicki <martin.burnicki@meinberg.de>2022-08-26 17:37:38 +0200
committerMartin Burnicki <martin.burnicki@meinberg.de>2022-08-26 17:37:38 +0200
commitaec234a7975f35e6c1227a95a5c22017e94fc621 (patch)
treeea86645c8ddd544cfd7727cf7dcca32fa16a8ede
parent422d45124dc10c8657399b3898622a3b14dda4c2 (diff)
downloadmbgtools-lx-aec234a7975f35e6c1227a95a5c22017e94fc621.tar.gz
mbgtools-lx-aec234a7975f35e6c1227a95a5c22017e94fc621.zip
Update comments in str_util
-rw-r--r--mbglib/common/str_util.c8
-rw-r--r--mbglib/common/str_util.h6
2 files changed, 9 insertions, 5 deletions
diff --git a/mbglib/common/str_util.c b/mbglib/common/str_util.c
index 16241cd..eae3881 100644
--- a/mbglib/common/str_util.c
+++ b/mbglib/common/str_util.c
@@ -1,7 +1,7 @@
/**************************************************************************
*
- * $Id: str_util.c 1.11 2021/03/22 11:28:52 martin REL_M $
+ * $Id: str_util.c 1.12 2022/08/26 15:01:49 martin.burnicki REL_M $
*
* Copyright (c) Meinberg Funkuhren, Bad Pyrmont, Germany
*
@@ -10,6 +10,8 @@
*
* -----------------------------------------------------------------------
* $Log: str_util.c $
+ * Revision 1.12 2022/08/26 15:01:49 martin.burnicki
+ * Updated a doxygen comment and fixed a typo in an older commit message.
* Revision 1.11 2021/03/22 11:28:52 martin
* Updated some comments.
* Revision 1.10 2021/03/16 12:20:37 martin
@@ -28,7 +30,7 @@
* Unified variable naming.
* More common __attribute__ syntax.
* Revision 1.4 2018/06/25 13:22:42 martin
- * Many functios return int rather than size_t, like standard
+ * Many functions return int rather than size_t, like standard
* library functions.
* do_str_copy_safe() now returns the number of chars copied.
* Revision 1.3 2016/10/24 08:10:04 thomas-b
@@ -158,7 +160,7 @@ int vsnprintf_safe( char *s, size_t max_len, const char *fmt, va_list args )
* @param[out] s The string buffer to be filled.
* @param[in] max_len Size of the output buffer for a 0-terminated string.
* @param[in] fmt Format string according to subsequent parameters.
- * @param[in] ... Variable argument list according to the format string.
+ * @param[in] ... Variable argument list according to the @p fmt format string.
*
* @return The number of characters written to the output buffer,
* except the terminating 0.
diff --git a/mbglib/common/str_util.h b/mbglib/common/str_util.h
index 2d5c8eb..efd9f39 100644
--- a/mbglib/common/str_util.h
+++ b/mbglib/common/str_util.h
@@ -1,7 +1,7 @@
/**************************************************************************
*
- * $Id: str_util.h 1.12 2021/03/22 11:27:45 martin REL_M $
+ * $Id: str_util.h 1.13 2022/08/26 15:02:13 martin.burnicki REL_M $
*
* Copyright (c) Meinberg Funkuhren, Bad Pyrmont, Germany
*
@@ -10,6 +10,8 @@
*
* -----------------------------------------------------------------------
* $Log: str_util.h $
+ * Revision 1.13 2022/08/26 15:02:13 martin.burnicki
+ * Updated a doxygen comment.
* Revision 1.12 2021/03/22 11:27:45 martin
* Updated some comments.
* Revision 1.11 2021/03/16 12:21:51 martin
@@ -236,7 +238,7 @@ out:
* @param[out] s The string buffer to be filled.
* @param[in] max_len Size of the output buffer for a 0-terminated string.
* @param[in] fmt Format string according to subsequent parameters.
- * @param[in] ... Variable argument list according to the format string.
+ * @param[in] ... Variable argument list according to the @p fmt format string.
*
* @return The number of characters written to the output buffer,
* except the terminating 0.