libsmbconf: Document smbconf_shutdown().
authorAndreas Schneider <asn@samba.org>
Thu, 14 Apr 2011 09:05:09 +0000 (11:05 +0200)
committerMichael Adam <obnox@samba.org>
Wed, 11 May 2011 10:03:29 +0000 (12:03 +0200)
Signed-off-by: Michael Adam <obnox@samba.org>
lib/smbconf/smbconf.h

index 5db8858d647445c07af4cda1fc7ae9221cf4b27c..f3d5909998d98124365235bba418a690941d07e1 100644 (file)
@@ -92,7 +92,13 @@ bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx);
  */
 bool smbconf_is_writeable(struct smbconf_ctx *ctx);
 
+/**
+ * @brief Close the configuration.
+ *
+ * @param[in] ctx       The smbconf context to close.
+ */
 void smbconf_shutdown(struct smbconf_ctx *ctx);
+
 bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn,
                     const char *service, const char *param);
 sbcErr smbconf_drop(struct smbconf_ctx *ctx);