[SSSD] [PATCH] DOC: Fix names of arguments in doxygen comments

Lukas Slebodnik lslebodn at redhat.com
Thu Feb 13 16:52:43 UTC 2014


ehlo,

I found few warning generated by doxygen in the ouput from building rpms.

For example:
./src/lib/idmap/sss_idmap.h:544: warning: argument 'smb_sid' of command @param
  is not found in the argument list of
  sss_idmap_free_bin_sid(struct sss_idmap_ctx *ctx, uint8_t *bin_sid)
./src/lib/idmap/sss_idmap.h:544: warning: The following parameters of
  sss_idmap_free_bin_sid(struct sss_idmap_ctx *ctx, uint8_t *bin_sid)
  are not documented: parameter 'bin_sid'

Patch is attached.

LS
-------------- next part --------------
>From 62f63e9d0567dbce02147f37de2e9565fdd68284 Mon Sep 17 00:00:00 2001
From: Lukas Slebodnik <lslebodn at redhat.com>
Date: Thu, 13 Feb 2014 17:46:29 +0100
Subject: [PATCH] DOC: Fix names of arguments in doxygen comments

---
 src/lib/idmap/sss_idmap.h            | 2 +-
 src/sss_client/idmap/sss_nss_idmap.h | 6 +++---
 src/util/util.h                      | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/lib/idmap/sss_idmap.h b/src/lib/idmap/sss_idmap.h
index 1e1c9a5cfe490301d0e633db808589f1bc0ef857..fe1e3c1ba1de1398dbb2284986135c00ad43683c 100644
--- a/src/lib/idmap/sss_idmap.h
+++ b/src/lib/idmap/sss_idmap.h
@@ -543,7 +543,7 @@ enum idmap_error_code sss_idmap_free_smb_sid(struct sss_idmap_ctx *ctx,
  * @brief Free mapped binary SID.
  *
  * @param[in] ctx         Idmap context
- * @param[in] smb_sid     Binary SID to be freed.
+ * @param[in] bin_sid     Binary SID to be freed.
  *
  * @return
  *  - #IDMAP_CONTEXT_INVALID: Provided context is invalid
diff --git a/src/sss_client/idmap/sss_nss_idmap.h b/src/sss_client/idmap/sss_nss_idmap.h
index be5c506e27f0e418022cff78b48ca3a37aacd5af..79dacfbdb1708569507742fbd8579cf7aaa06d9b 100644
--- a/src/sss_client/idmap/sss_nss_idmap.h
+++ b/src/sss_client/idmap/sss_nss_idmap.h
@@ -43,7 +43,7 @@ enum sss_id_type {
  * @param[in] fq_name  Fully qualified name of a user or a group
  * @param[out] sid     String representation of the SID of the requested user
  *                     or group, must be freed by the caller
- * @param[out] id_type Type of the object related to the given name
+ * @param[out] type    Type of the object related to the given name
  *
  * @return
  *  - 0 (EOK): success, sid contains the requested SID
@@ -63,7 +63,7 @@ int sss_nss_getsidbyname(const char *fq_name, char **sid,
  * @param[in] id       POSIX UID or GID
  * @param[out] sid     String representation of the SID of the requested user
  *                     or group, must be freed by the caller
- * @param[out] id_type Type of the object related to the given ID
+ * @param[out] type    Type of the object related to the given ID
  *
  * @return
  *  - see #sss_nss_getsidbyname
@@ -76,7 +76,7 @@ int sss_nss_getsidbyid(uint32_t id, char **sid, enum sss_id_type *type);
  * @param[in] sid      String representation of the SID
  * @param[out] fq_name Fully qualified name of a user or a group,
  *                     must be freed by the caller
- * @param[out] id_type Type of the object related to the SID
+ * @param[out] type    Type of the object related to the SID
  *
  * @return
  *  - see #sss_nss_getsidbyname
diff --git a/src/util/util.h b/src/util/util.h
index 14d79748099dad3661d86aec8965bbf5089a92cb..b5e742f6ec48000ecce831066dbbdcb27ef10718 100644
--- a/src/util/util.h
+++ b/src/util/util.h
@@ -460,7 +460,7 @@ bool string_in_list(const char *string, char **list, bool case_sensitive);
  *        prevents the compiler from optimizing out
  *
  * @param data   The address of buffer to wipe
- * @param s      Size of the buffer
+ * @param size   Size of the buffer
  */
 void safezero(void *data, size_t size);
 
-- 
1.8.5.3



More information about the sssd-devel mailing list