Change in libosmocore[master]: src/logging.c: fix syntax errors in Doxygen documentation

Vadim Yanitskiy gerrit-no-reply at lists.osmocom.org
Mon Mar 25 15:07:05 UTC 2019


Vadim Yanitskiy has uploaded this change for review. ( https://gerrit.osmocom.org/13401


Change subject: src/logging.c: fix syntax errors in Doxygen documentation
......................................................................

src/logging.c: fix syntax errors in Doxygen documentation

This change should fix the following warnings:

  logging.c:956: warning: unable to resolve reference to `talloc'
                 for \ref command
  logging.c:203: warning: argument 'in' of command @param is not
                 found in the argument list of
                 log_level_str(unsigned int lvl)
  logging.c:194: warning: argument 'in' of command @param is not
                 found in the argument list of
                 log_parse_level(const char *lvl)
  logging.c:708: warning: argument 'print_catname' of command
                 @param is not found in the argument list of
                 log_set_print_category(struct log_target *target,
                                        int print_category)
  logging.c:687: warning: argument 'print_filename' of command
                 @param is not found in the argument list of
                 log_set_print_filename2(struct log_target *target,
                                         enum log_filename_type lft)
  logging.c:729: warning: argument 'print_catname' of command
                 @param is not found in the argument list of
                 log_set_print_level(struct log_target *target,
                                     int print_level)
  logging.c:893: warning: argument 'in' of command @param is not
                 found in the argument list of
                 log_target_destroy(struct log_target *target)

Change-Id: I85f6c70216b7574b49b90bb1469869a47f721713
---
M src/logging.c
1 file changed, 7 insertions(+), 7 deletions(-)



  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/01/13401/1

diff --git a/src/logging.c b/src/logging.c
index 09021e4..73a9c52 100644
--- a/src/logging.c
+++ b/src/logging.c
@@ -192,7 +192,7 @@
 }
 
 /*! Parse a human-readable log level into a numeric value
- *  \param lvl[in] zero-terminated string containing log level name
+ *  \param[in] lvl zero-terminated string containing log level name
  *  \returns numeric log level
  */
 int log_parse_level(const char *lvl)
@@ -201,7 +201,7 @@
 }
 
 /*! convert a numeric log level into human-readable string
- *  \param lvl[in] numeric log level
+ *  \param[in] lvl numeric log level
  *  \returns zero-terminated string (log level name)
  */
 const char *log_level_str(unsigned int lvl)
@@ -685,7 +685,7 @@
 
 /*! Enable or disable printing of the filename while logging.
  *  \param[in] target Log target to be affected.
- *  \param[in] print_filename An LOG_FILENAME_* enum value.
+ *  \param[in] lft An LOG_FILENAME_* enum value.
  * LOG_FILENAME_NONE omits the source file and line information from logs.
  * LOG_FILENAME_PATH prints the entire source file path as passed to LOGP macros.
  */
@@ -707,7 +707,7 @@
 
 /*! Enable or disable printing of the category name
  *  \param[in] target Log target to be affected
- *  \param[in] print_catname Enable (1) or disable (0) filenames
+ *  \param[in] print_category Enable (1) or disable (0) filenames
  *
  *  Print the category/subsys name in front of every log message.
  */
@@ -727,7 +727,7 @@
 
 /*! Enable or disable printing of the log level name.
  *  \param[in] target Log target to be affected
- *  \param[in] print_catname Enable (1) or disable (0) filenames
+ *  \param[in] print_level Enable (1) or disable (0) log level name
  *
  *  Print the log level name in front of every log message.
  */
@@ -891,7 +891,7 @@
 }
 
 /*! Unregister, close and delete a log target
- *  \param target[in] log target to unregister, close and delete */
+ *  \param[in] target log target to unregister, close and delete */
 void log_target_destroy(struct log_target *target)
 {
 
@@ -954,7 +954,7 @@
 
 /*! Initialize the Osmocom logging core
  *  \param[in] inf Information regarding logging categories, could be NULL
- *  \param[in] ctx \ref talloc context for logging allocations
+ *  \param[in] ctx talloc context for logging allocations
  *  \returns 0 in case of success, negative in case of error
  *
  *  If inf is NULL then only library-internal categories are initialized.

-- 
To view, visit https://gerrit.osmocom.org/13401
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: I85f6c70216b7574b49b90bb1469869a47f721713
Gerrit-Change-Number: 13401
Gerrit-PatchSet: 1
Gerrit-Owner: Vadim Yanitskiy <axilirator at gmail.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20190325/97df3c5f/attachment.html>


More information about the gerrit-log mailing list