From: Andreas Schneider <asn@samba.org>
Date: Thu, 14 Apr 2011 09:35:11 +0000 (+0200)
Subject: libsmbconf: Document smbconf_get_parameter().
X-Git-Tag: samba-3.6.0rc1~106
X-Git-Url: http://git.samba.org/?a=commitdiff_plain;h=a315cc58e03ee95c70a84adc8e21aa35966957e7;p=samba.git

libsmbconf: Document smbconf_get_parameter().

Signed-off-by: Michael Adam <obnox@samba.org>
(cherry picked from commit 53aa10a277262efd48489fb8eab49b5b4fdb2e39)
---

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 6bc00d43ff7..83f62746ec0 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -267,11 +267,28 @@ sbcErr smbconf_set_parameter(struct smbconf_ctx *ctx,
 sbcErr smbconf_set_global_parameter(struct smbconf_ctx *ctx,
 				    const char *param, const char *val);
 
+/**
+ * @brief Get the value of a configuration parameter as a string.
+ *
+ * @param[in]  ctx      The smbconf context to use.
+ *
+ * @param[in]  mem_ctx  The memory context to allocate the string on.
+ *
+ * @param[in]  service  The name of the service where to find the parameter.
+ *
+ * @param[in]  param    The parameter to get.
+ *
+ * @param[out] valstr   A pointer to store the value as a string.
+ *
+ * @return              SBC_ERR_OK on success, a corresponding sbcErr if an
+ *                      error occured.
+ */
 sbcErr smbconf_get_parameter(struct smbconf_ctx *ctx,
 			     TALLOC_CTX *mem_ctx,
 			     const char *service,
 			     const char *param,
 			     char **valstr);
+
 sbcErr smbconf_get_global_parameter(struct smbconf_ctx *ctx,
 				    TALLOC_CTX *mem_ctx,
 				    const char *param,