From 600f3c3fe57a2398589f7eb60c130b1ae6c8b2d6 Mon Sep 17 00:00:00 2001
From: Fufu Fang <fangfufu2003@gmail.com>
Date: Tue, 27 Aug 2019 10:52:46 +0100
Subject: [PATCH] added more documentation

---
 src/network.c | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/src/network.c b/src/network.c
index 67dcc4b..1cae5ef 100644
--- a/src/network.c
+++ b/src/network.c
@@ -32,6 +32,10 @@ static pthread_mutex_t curl_lock;
 /* -------------------- Functions -------------------------- */
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wunused-function"
+/**
+ * \note
+ * Required for OpenSSL 1.02, but not OpenSSL 1.1
+ */
 static void crypto_lock_callback(int mode, int type, char *file, int line)
 {
     (void)file;
@@ -43,6 +47,10 @@ static void crypto_lock_callback(int mode, int type, char *file, int line)
     }
 }
 
+/**
+ * \note
+ * Required for OpenSSL 1.02, but not OpenSSL 1.1
+ */
 static unsigned long thread_id(void)
 {
     unsigned long ret;
@@ -67,7 +75,7 @@ static void crypto_lock_init(void)
 }
 
 /**
- * Adapted from:
+ * \note Adapted from:
  * https://curl.haxx.se/libcurl/c/threaded-shared-conn.html
  */
 static void curl_callback_lock(CURL *handle, curl_lock_data data,
@@ -90,7 +98,7 @@ static void curl_callback_unlock(CURL *handle, curl_lock_data data,
 }
 
 /**
- * Adapted from:
+ * \note Adapted from:
  * https://curl.haxx.se/libcurl/c/10-at-a-time.html
  */
 static void curl_process_msgs(CURLMsg *curl_msg, int n_running_curl,
@@ -147,7 +155,7 @@ static void curl_process_msgs(CURLMsg *curl_msg, int n_running_curl,
 }
 
 /**
- * \details effectively based on
+ * \note  effectively based on
  * https://curl.haxx.se/libcurl/c/multi-double.html
  */
 int curl_multi_perform_once()