From 7a57ccd2c5d64680bf6386d8fa0c1443819a6f42 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Thu, 14 Apr 2011 11:02:49 +0200 Subject: libsmbconf: Document smbconf_backend_requires_messaging(). Signed-off-by: Michael Adam --- lib/smbconf/smbconf.h | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h index 467b5caa79..8e3b40b7a1 100644 --- a/lib/smbconf/smbconf.h +++ b/lib/smbconf/smbconf.h @@ -58,6 +58,10 @@ struct smbconf_service { char **param_values; }; +/* + * The smbconf API functions + */ + /** * @brief Translate an error value into a string * @@ -67,10 +71,18 @@ struct smbconf_service { **/ const char *sbcErrorString(sbcErr error); -/* - * the smbconf API functions +/** + * @brief Check if the backend requires messaging to be set up. + * + * Tell whether the backend requires messaging to be set up + * for the backend to work correctly. + * + * @param[in] ctx The smbconf context to check. + * + * @return True if needed, false if not. */ bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx); + 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, -- cgit