libsmbconf: Document smbconf_is_writeable().

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

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 8e3b40b7a1a72b4b29564b52d3683b1e4cf416ac..5db8858d647445c07af4cda1fc7ae9221cf4b27c 100644 (file)
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -83,7 +83,15 @@ const char *sbcErrorString(sbcErr error);
  */
 bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx);
 
+/**
+ * @brief Tell whether the source is writeable.
+ *
+ * @param[in] ctx       The smbconf context to check.
+ *
+ * @return              True if it is writeable, false if not.
+ */
 bool smbconf_is_writeable(struct smbconf_ctx *ctx);
+
 void smbconf_shutdown(struct smbconf_ctx *ctx);
 bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn,
                     const char *service, const char *param);