add log messages

1 files changed, 8 insertions, 0 deletions

diff --git a/url.h b/url.h
index b60f548..49b0aa1 100644
--- a/url.h
+++ b/url.h
@@ -35,6 +35,14 @@
 
 /*
  * Build an URL from the provided components.
+ * The first argument is the destination buffer where the URL will be written.
+ * It is required.
+ * The second argument is the size of the destination buffer. It is required.
+ * The third argument is the number of URL components provided in the following
+ * vargs.
+ * Returns the number of characters written to the destination buffer. If it
+ * is equal to the destination buffer size, it means the buffer was too small
+ * and the resulting URL has been truncated.
  */
 size_t
 url_build(char *, size_t, int,...);