[vlc-devel] [PATCH] http: add some much needed documentation

[Shaleen Jain]

---
 include/vlc_httpd.h | 41 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

diff --git a/include/vlc_httpd.h b/include/vlc_httpd.h
index 29b8229e7b..0b5a04c43c 100644
--- a/include/vlc_httpd.h
+++ b/include/vlc_httpd.h
@@ -64,10 +64,49 @@ enum
 
 typedef struct httpd_host_t   httpd_host_t;
 typedef struct httpd_client_t httpd_client_t;
-/* create a new host */
+
+/**
+ * Create a new HTTP host.
+ *
+ * @note The VLC Object should have the following variables set:
+ * "http-host" network address or hostname, empty to listen on all interfaces.
+ * "http-port" port number, if NULL port number is left uninitialized.
+ *
+ * @param a derived object of the vlc_object_t type
+ *
+ * @return httpd_host_t NULL if creation failed.
+ */
 VLC_API httpd_host_t *vlc_http_HostNew( vlc_object_t * ) VLC_USED;
+
+/**
+ * Create a new HTTPS host.
+ *
+ * @note The VLC Object should have the following variables set:
+ * "http-cert" cert path to an x509 certificate
+ * "http-key"  path to the PKCS private key for the certificate,
+ *             or NULL to use cert path
+ * "http-host" network address or hostname, empty to listen on all interfaces.
+ * "http-port" port number, if NULL port number is left uninitialized.
+ *
+ * @param a derived object of the vlc_object_t type
+ *
+ * @return httpd_host_t NULL if creation failed.
+ */
 VLC_API httpd_host_t *vlc_https_HostNew( vlc_object_t * ) VLC_USED;
+
+/**
+ * Create a new RTSP host.
+ *
+ * @note The VLC Object should have the following variables set:
+ * "rtsp-host" network address or hostname, empty to listen on all interfaces.
+ * "rtsp-port" port number, if NULL port number is left uninitialized.
+ *
+ * @param a derived object of the vlc_object_t type
+ *
+ * @return httpd_host_t NULL if creation failed.
+ */
 VLC_API httpd_host_t *vlc_rtsp_HostNew( vlc_object_t * ) VLC_USED;
+
 /* delete a host */
 VLC_API void httpd_HostDelete( httpd_host_t * );
 
-- 
2.19.1