[SSSD] [PATCH] Fix some doxygen warnings

Sumit Bose sbose at redhat.com
Tue Jun 11 10:07:41 UTC 2013


Hi,

this patch fixes some warning which were shown during 'make docs'.

bye,
Sumit
-------------- next part --------------
From a7b9ce79ba818524b376b4cfc49b8cdf3d718604 Mon Sep 17 00:00:00 2001
From: Sumit Bose <sbose at redhat.com>
Date: Tue, 11 Jun 2013 11:46:28 +0200
Subject: [PATCH] Fix some doxygen warnings

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

diff --git a/src/confdb/confdb.h b/src/confdb/confdb.h
index e111102..01eade2 100644
--- a/src/confdb/confdb.h
+++ b/src/confdb/confdb.h
@@ -374,7 +374,6 @@ int confdb_get_string(struct confdb_ctx *cdb, TALLOC_CTX *ctx,
  * integer
  *
  * @param[in] cdb The connection object to the confdb
- * @param[in] ctx The parent memory context for the returned string
  * @param[in] section The ConfDB section to update. This is constructed from
  *                    the format of the sssd.conf file. All sections start
  *                    with 'config/'. Subsections are separated by slashes.
@@ -405,7 +404,6 @@ int confdb_get_int(struct confdb_ctx *cdb,
  * value from the ConfDB and convert it to an integral bool value.
  *
  * @param[in] cdb The connection object to the confdb
- * @param[in] ctx The parent memory context for the returned string
  * @param[in] section The ConfDB section to update. This is constructed from
  *                    the format of the sssd.conf file. All sections start
  *                    with 'config/'. Subsections are separated by slashes.
diff --git a/src/lib/idmap/sss_idmap.h b/src/lib/idmap/sss_idmap.h
index 9204be0..9710501 100644
--- a/src/lib/idmap/sss_idmap.h
+++ b/src/lib/idmap/sss_idmap.h
@@ -73,7 +73,7 @@ enum idmap_error_code {
     /** The provided SID is a built-in one */
     IDMAP_BUILTIN_SID,
 
-    /* No more free slices */
+    /** No more free slices */
     IDMAP_OUT_OF_SLICES
 };
 
@@ -195,7 +195,7 @@ sss_idmap_ctx_get_upper(struct sss_idmap_ctx *ctx, id_t *_upper);
  * @brief Get the range size of POSIX IDs available for single domain
  *
  * @param[in] ctx           idmap context
- * @param[out] _rangesize   returned range size
+ * @param[out] rangesize    returned range size
  */
 enum idmap_error_code
 sss_idmap_ctx_get_rangesize(struct sss_idmap_ctx *ctx, id_t *rangesize);
@@ -206,7 +206,7 @@ sss_idmap_ctx_get_rangesize(struct sss_idmap_ctx *ctx, id_t *rangesize);
  * @param[in] ctx           Idmap context
  * @param[in] dom_sid       Zero-terminated string representation of the domain
  *                          SID (S-1-15-.....)
- * @param[in/out] slice_num Slice number to be used. Set this pointer to NULL or
+ * @param[in,out] slice_num Slice number to be used. Set this pointer to NULL or
  *                          the addressed value to -1 to calculate slice number
  *                          automatically. The calculated value will be
  *                          returned in this parameter.
-- 
1.7.7.6



More information about the sssd-devel mailing list