libsmbconf: Document smbconf_delete_global_includes().
authorAndreas Schneider <asn@samba.org>
Thu, 14 Apr 2011 09:50:05 +0000 (11:50 +0200)
committerMichael Adam <obnox@samba.org>
Tue, 10 May 2011 17:13:25 +0000 (19:13 +0200)
Signed-off-by: Michael Adam <obnox@samba.org>
lib/smbconf/smbconf.h

index 52fe32a4e30f39a7a65a8ef366653532c78234ac..0268ad4bd48c1725b1d1f9e5b73b8805a4f4afdb 100644 (file)
@@ -425,6 +425,14 @@ sbcErr smbconf_set_global_includes(struct smbconf_ctx *ctx,
  */
 sbcErr smbconf_delete_includes(struct smbconf_ctx *ctx, const char *service);
 
+/**
+ * @brief Delete include parameter from the global service.
+ *
+ * @param[in]  ctx      The smbconf context to use.
+ *
+ * @return              SBC_ERR_OK on success, a corresponding sbcErr if an
+ *                      error occured.
+ */
 sbcErr smbconf_delete_global_includes(struct smbconf_ctx *ctx);
 
 sbcErr smbconf_transaction_start(struct smbconf_ctx *ctx);