From: Hypolite Petovan <mrpetovan@gmail.com>
Date: Sun, 7 May 2017 19:00:38 +0000 (-0400)
Subject: Updated doc in include/probe.php
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=92550861e9dc1294fd1a1822c575e3c905a783c2;p=friendica.git

Updated doc in include/probe.php

- Fix standards
---

diff --git a/include/probe.php b/include/probe.php
index 2d52059847..8cf703be80 100644
--- a/include/probe.php
+++ b/include/probe.php
@@ -2,15 +2,6 @@
 
 use Friendica\Network\Probe;
 
-/**
- *
- * Probe a network address to discover what kind of protocols we need to communicate with it.
- *
- * Warning: this function is a bit touchy and there are some subtle dependencies within the logic flow.
- * Edit with care.
- *
- */
-
 /**
  *
  * PROBE_DIASPORA has a bias towards returning Diaspora information
@@ -19,16 +10,30 @@ use Friendica\Network\Probe;
  * of network.
  *
  */
-
 define('PROBE_NORMAL',   0);
 define('PROBE_DIASPORA', 1);
 
-function probe_url($url, $mode = PROBE_NORMAL, $level = 1) {
+/**
+ * @brief Probes a network address to discover what kind of protocols we need to communicate with it.
+ *
+ * Warning: this function is a bit touchy and there are some subtle dependencies within the logic flow.
+ * Edit with care.
+ *
+ * @deprecated Use Friendica\Network\Probe instead
+ *
+ * @see Friendica\Network\Probe::uri()
+ *
+ * @param string $url Any URI
+ * @param int $mode One of the PROBE_* constants
+ * @return array Same data array returned by Friendica\Network\Probe::uri()
+ */
+function probe_url($url, $mode = PROBE_NORMAL) {
 
-	if ($mode == PROBE_DIASPORA)
+	if ($mode == PROBE_DIASPORA) {
 		$network = NETWORK_DIASPORA;
-	else
-		$network = "";
+	} else {
+		$network = '';
+	}
 
 	$data = Probe::uri($url, $network);