aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2020-09-28 08:41:47 -0400
committerNick Mathewson <nickm@torproject.org>2020-09-28 08:41:47 -0400
commite68770719ef4d3d3b83398715b1e10391ab6a1b4 (patch)
tree4465858e1421e94de60776f0c7641ea1e61955ef /src
parent228ac47c2cc2625e08c689af6a7cdae592923acb (diff)
downloadtor-e68770719ef4d3d3b83398715b1e10391ab6a1b4.tar.gz
tor-e68770719ef4d3d3b83398715b1e10391ab6a1b4.zip
Add missing documentation for get_net_param_from_list
Diffstat (limited to 'src')
-rw-r--r--src/feature/nodelist/networkstatus.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/feature/nodelist/networkstatus.c b/src/feature/nodelist/networkstatus.c
index 9210518de0..ece3c9e059 100644
--- a/src/feature/nodelist/networkstatus.c
+++ b/src/feature/nodelist/networkstatus.c
@@ -2444,7 +2444,12 @@ networkstatus_getinfo_by_purpose(const char *purpose_string, time_t now)
return answer;
}
-/* DOCDOC get_net_param_from_list */
+/**
+ * Search through a smartlist of "key=int32" strings for a value beginning
+ * with "param_name=". If one is found, clip it to be between min_val and
+ * max_val inclusive and return it. If one is not found, return
+ * default_val.
+ ***/
static int32_t
get_net_param_from_list(smartlist_t *net_params, const char *param_name,
int32_t default_val, int32_t min_val, int32_t max_val)