From 58a444b4305bd8a1c2ab7ee172c3972e091cc964 Mon Sep 17 00:00:00 2001
From: Hypolite Petovan <ben.lort@gmail.com>
Date: Sat, 18 Feb 2017 20:39:16 -0500
Subject: [PATCH] Add original_url() param documentation

---
 include/network.php | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/include/network.php b/include/network.php
index 727d5e57ec..03f65a5190 100644
--- a/include/network.php
+++ b/include/network.php
@@ -721,12 +721,14 @@ function strip_tracking_query_params($url)
  * This function strips tracking query params and follows redirections, either
  * through HTTP code or meta refresh tags. Stops after 10 redirections.
  *
+ * @todo Remove the $fetchbody parameter that generates an extraneous HEAD request
+ *
  * @see ParseUrl::getSiteinfo
  *
- * @param string $url
- * @param int $depth
- * @param bool $fetchbody
- * @return string
+ * @param string $url A user-submitted URL
+ * @param int $depth The current redirection recursion level (internal)
+ * @param bool $fetchbody Wether to fetch the body or not after the HEAD requests
+ * @return string A canonical URL
  */
 function original_url($url, $depth = 1, $fetchbody = false) {
 	$a = get_app();