From e4c38b088e0e873f2f6fac7cc0fe741161f3460a Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:04:15 +0200 Subject: [PATCH] libsmbconf: Document smbconf_is_writeable(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 8e3b40b7a1a..5db8858d647 100644 --- 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); -- 2.11.4.GIT