libsmbconf: Document smbconf_create_share().

[gd/samba-autobuild/.git] / lib / smbconf / smbconf.h

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index d208af154c468e14e746ce1b1a113b3f09b15407..8becb5f2849b5ee40c6631ca13686a097afff4a2 100644 (file)
--- 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,