From: Andreas Schneider <asn@samba.org>
Date: Thu, 14 Apr 2011 09:44:22 +0000 (+0200)
Subject: libsmbconf: Document smbconf_get_includes().
X-Git-Url: http://git.samba.org/?a=commitdiff_plain;h=74dc8c351c33a3b73251985ffa3b19ec024bcfc9;hp=b7ba46d1c0e1fdd5b68dd0478d38a633938aae84;p=metze%2Fsamba%2Fwip.git

libsmbconf: Document smbconf_get_includes().

Signed-off-by: Michael Adam <obnox@samba.org>
---

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 49f1b70aa243..4d511a08aad1 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -340,10 +340,27 @@ sbcErr smbconf_delete_parameter(struct smbconf_ctx *ctx,
 sbcErr smbconf_delete_global_parameter(struct smbconf_ctx *ctx,
 				       const char *param);
 
+/**
+ * @brief Get the list of names of included files.
+ *
+ * @param[in]  ctx      The smbconf context to use.
+ *
+ * @param[in]  mem_ctx  The memory context to allocate the names.
+ *
+ * @param[in]  service  The service name to get the include files.
+ *
+ * @param[out] num_includes A pointer to store the number of included files.
+ *
+ * @param[out] includes A pointer to store the paths of the included files.
+ *
+ * @return              SBC_ERR_OK on success, a corresponding sbcErr if an
+ *                      error occured.
+ */
 sbcErr smbconf_get_includes(struct smbconf_ctx *ctx,
 			    TALLOC_CTX *mem_ctx,
 			    const char *service,
 			    uint32_t *num_includes, char ***includes);
+
 sbcErr smbconf_get_global_includes(struct smbconf_ctx *ctx,
 				   TALLOC_CTX *mem_ctx,
 				   uint32_t *num_includes, char ***includes);