libsmbconf: Document smbconf_set_parameter().

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

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 5d8ce70351388a27896a76efa5c54eef6b0d006d..2f1affaa1591d4bb45d06d980de846cb359cf0da 100644 (file)
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -230,10 +230,25 @@ sbcErr smbconf_get_share(struct smbconf_ctx *ctx,
 sbcErr smbconf_delete_share(struct smbconf_ctx *ctx,
                            const char *servicename);
 
+/**
+ * @brief Set a configuration parameter to the value provided.
+ *
+ * @param[in] ctx       The smbconf context to use.
+ *
+ * @param[in] service   The service name to set the parameter.
+ *
+ * @param[in] param     The name of the parameter to set.
+ *
+ * @param[in] valstr    The value to set.
+ *
+ * @return              SBC_ERR_OK on success, a corresponding sbcErr if an
+ *                      error occured.
+ */
 sbcErr smbconf_set_parameter(struct smbconf_ctx *ctx,
                             const char *service,
                             const char *param,
                             const char *valstr);
+
 sbcErr smbconf_set_global_parameter(struct smbconf_ctx *ctx,
                                    const char *param, const char *val);
 sbcErr smbconf_get_parameter(struct smbconf_ctx *ctx,