libsmbconf: Document smbconf_share_exists().

[ira/wip.git] / lib / smbconf / smbconf.h

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 0a46874fc5bb9987fd72d0edbfbd9561f05204b5..d208af154c468e14e746ce1b1a113b3f09b15407 100644 (file)
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -172,7 +172,17 @@ sbcErr smbconf_get_share_names(struct smbconf_ctx *ctx,
                               uint32_t *num_shares,
                               char ***share_names);
 
+/**
+ * @brief Check if a share/service of a given name exists.
+ *
+ * @param[in] ctx       The smbconf context to use.
+ *
+ * @param[in] servicename The service name to check if it exists.
+ *
+ * @return              True if it exists, false if not.
+ */
 bool smbconf_share_exists(struct smbconf_ctx *ctx, const char *servicename);
+
 sbcErr smbconf_create_share(struct smbconf_ctx *ctx, const char *servicename);
 sbcErr smbconf_get_share(struct smbconf_ctx *ctx,
                         TALLOC_CTX *mem_ctx,