Documentation on All-Products interface

1 files changed, 5 insertions, 0 deletions

diff --git a/icclient/client.h b/icclient/client.h
index 4a25d5b..cd3769e 100644
--- a/icclient/client.h
+++ b/icclient/client.h
@@ -18,6 +18,11 @@ extern "C" {
 	 */
 	bool icclient_init(const char *url, const char *certificate);
 
+	/*!
+	 * \brief For fetching data about all active products.
+	 * \param handler A pointer to a cURL write function callback.
+	 * \param catalogptr A pointer to the catalog to store the data.
+	 */
 	void icclient_allproducts(size_t (*handler)(void *contents, size_t size
 				, size_t nmemb, void *userdata)
 			, struct icclient_catalog **catalogptr);