friendica
/
friendica
mirror of https://github.com/friendica/friendica
6
0
Fork 1
Code Issues Packages Projects Releases 1 Wiki Activity

Some more documentation

This commit is contained in:
Michael Vogel 2016-07-10 18:44:48 +02:00
parent 19d820a9c4
commit aad3fb2d32
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/Probe.php
View File

@ -200,7 +200,7 @@ class Probe {
} }
/** /**
* @brief Fetch information about a given uri * @brief Fetch information (protocol endpoints and user information) about a given uri
* *
* @param string $uri Address that should be probed * @param string $uri Address that should be probed
* @param string $network Test for this specific network * @param string $network Test for this specific network
@ -279,7 +279,9 @@ class Probe {
} }
/** /**
* @brief Detect information about a given uri * @brief Fetch information (protocol endpoints and user information) about a given uri
*
* This function is only called by the "uri" function that adds caching and rearranging of data.
* *
* @param string $uri Address that should be probed * @param string $uri Address that should be probed
* @param string $network Test for this specific network * @param string $network Test for this specific network
@ -406,7 +408,7 @@ class Probe {
} }
/** /**
* @brief Do a webfinger request * @brief Do a webfinger request. For details see RFC 7033: <https://tools.ietf.org/html/rfc7033>
* *
* @param string $url Address that should be probed * @param string $url Address that should be probed
* *
@ -460,6 +462,8 @@ class Probe {
/** /**
* @brief Poll the noscrape page (Friendica specific) * @brief Poll the noscrape page (Friendica specific)
* *
* "noscrape" is a faster alternative to fetching the data from the hcard.
*
* @param string $noscrape Link to the noscrape page * @param string $noscrape Link to the noscrape page
* @param array $data The already fetched data * @param array $data The already fetched data
* *
@ -543,7 +547,7 @@ class Probe {
} }
/** /**
* @brief Fetch data from a DFRN profile page * @brief Fetch data from a DFRN profile page and via "noscrape"
* *
* @param string $profile Link to the profile page * @param string $profile Link to the profile page
* *