From: Andreas Schneider <asn@samba.org>
Date: Thu, 14 Apr 2011 09:25:07 +0000 (+0200)
Subject: libsmbconf: Document smbconf_create_share().
X-Git-Tag: samba-4.0.0alpha16^2~925
X-Git-Url: http://git.samba.org/?p=samba.git;a=commitdiff_plain;h=529e0645860cf43f8a507c87fa7c581c29fa5987

libsmbconf: Document smbconf_create_share().

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

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index d208af154c4..8becb5f2849 100644
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -183,7 +183,18 @@ sbcErr smbconf_get_share_names(struct smbconf_ctx *ctx,
  */
 bool smbconf_share_exists(struct smbconf_ctx *ctx, const char *servicename);
 
+/**
+ * @brief Add a service if it does not already exist.
+ *
+ * @param[in] ctx       The smbconf context to use.
+ *
+ * @param[in] servicename The name of the service to add.
+ *
+ * @return              SBC_ERR_OK on success, a corresponding sbcErr if an
+ *                      error occured.
+ */
 sbcErr smbconf_create_share(struct smbconf_ctx *ctx, const char *servicename);
+
 sbcErr smbconf_get_share(struct smbconf_ctx *ctx,
 			 TALLOC_CTX *mem_ctx,
 			 const char *servicename,