libsmbconf: Document smbconf_transaction_cancel().

[samba.git] / lib / smbconf / smbconf.h

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index fffdd7613e30e5afc33bad03d365c6c4f27f6799..4c2bacf87f80a64ffc4ffb60e17a53609c84264a 100644 (file)
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -461,6 +461,16 @@ sbcErr smbconf_transaction_start(struct smbconf_ctx *ctx);
  */
 sbcErr smbconf_transaction_commit(struct smbconf_ctx *ctx);
 
+/**
+ * @brief Cancel a transaction on the configuration backend.
+ *
+ * @param[in] ctx       The smbconf context to cancel the transaction.
+ *
+ * @return              SBC_ERR_OK on success, a corresponding sbcErr if an
+ *                      error occured.
+ *
+ * @see smbconf_transaction_start()
+ */
 sbcErr smbconf_transaction_cancel(struct smbconf_ctx *ctx);
 
 #endif /*  _LIBSMBCONF_H_  */