libsmbconf: Document smbconf_delete_includes().

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

diff --git a/lib/smbconf/smbconf.h b/lib/smbconf/smbconf.h
index 10c7a78e320e9d79a7e7c29a8431a5d66bcb6e80..52fe32a4e30f39a7a65a8ef366653532c78234ac 100644 (file)
--- a/lib/smbconf/smbconf.h
+++ b/lib/smbconf/smbconf.h
@@ -412,7 +412,19 @@ sbcErr smbconf_set_includes(struct smbconf_ctx *ctx,
 sbcErr smbconf_set_global_includes(struct smbconf_ctx *ctx,
                                   uint32_t num_includes,
                                   const char **includes);
+
+/**
+ * @brief Delete include parameter on the given service.
+ *
+ * @param[in]  ctx      The smbconf context to use.
+ *
+ * @param[in]  service  The name of the service to delete the includes from.
+ *
+ * @return              SBC_ERR_OK on success, a corresponding sbcErr if an
+ *                      error occured.
+ */
 sbcErr smbconf_delete_includes(struct smbconf_ctx *ctx, const char *service);
+
 sbcErr smbconf_delete_global_includes(struct smbconf_ctx *ctx);
 
 sbcErr smbconf_transaction_start(struct smbconf_ctx *ctx);