add PHPDoc

Author: michaelkonecny

src/IndieWeb/link_rel_parser.php

@@ -6,8 +6,10 @@
 license: http://creativecommons.org/publicdomain/zero/1.0/
 */
 
-// in $h: HTTP headers as a string
-// returns: array of rel values as indices to arrays of URLs
+/**
+ * @param string $h  HTTP headers
+ * @return array $rels rel values as indices to arrays of URLs
+ */
 function http_rels($h) {
   $h = preg_replace("/(\r\n|\r)/", "\n", $h);
   $h = explode("\n", preg_replace("/(\n)[ \t]+/", " ", $h));
@@ -33,8 +35,8 @@ function http_rels($h) {
           foreach ($relarray as $rel) {
             $rel = strtolower(trim($rel));
             if ($rel != '') {
-              if (!array_key_exists($rel, $rels)) { 
-                $rels[$rel] = array(); 
+              if (!array_key_exists($rel, $rels)) {
+                $rels[$rel] = array();
               }
               if (!in_array($href, $rels[$rel])) {
                 $rels[$rel][] = $href;
@@ -48,19 +50,18 @@ function http_rels($h) {
   return $rels;
 }
 
-// in $url: URL to get HTTP HEAD Link (and effective/x-extended) rels 
-// returns: array of 
-//        "status"=> HTTP status code, 
-//        "type"=> HTTP Content-Type
-//        "rels" array with http_rels return value
+/**
+ * @param $url  URL to get HTTP HEAD Link (and effective/x-extended) rels
+ * @return array  "status"=> HTTP status code, "type"=> HTTP Content-Type, "rels" array with http_rels return value
+ */
 function head_http_rels($url) {
-	$c = curl_init();
-	curl_setopt($c, CURLOPT_RETURNTRANSFER, 1);
-	curl_setopt($c, CURLOPT_URL, $url);
-	curl_setopt($c, CURLOPT_CONNECTTIMEOUT, 2);
-	curl_setopt($c, CURLOPT_TIMEOUT, 4);
-	curl_setopt($c, CURLOPT_USERAGENT, 'head_http_rels function');
-	curl_setopt($c, CURLOPT_FOLLOWLOCATION, 1);
+  $c = curl_init();
+  curl_setopt($c, CURLOPT_RETURNTRANSFER, 1);
+  curl_setopt($c, CURLOPT_URL, $url);
+  curl_setopt($c, CURLOPT_CONNECTTIMEOUT, 2);
+  curl_setopt($c, CURLOPT_TIMEOUT, 4);
+  curl_setopt($c, CURLOPT_USERAGENT, 'head_http_rels function');
+  curl_setopt($c, CURLOPT_FOLLOWLOCATION, 1);
   curl_setopt($c, CURLOPT_SSL_VERIFYPEER , false );
   curl_setopt($c, CURLOPT_SSL_VERIFYHOST , false );
   curl_setopt($c, CURLOPT_HEADER, true);