1
0
Fork 0

Fix PHPDoc comments project-wide

This commit is contained in:
Hypolite Petovan 2019-01-06 16:06:53 -05:00
commit 3282ce5389
113 changed files with 1703 additions and 795 deletions

View file

@ -31,6 +31,7 @@ class GContact
* @param string $mode Search mode (e.g. "community")
*
* @return array with search results
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function searchByName($search, $mode = '')
{
@ -91,6 +92,7 @@ class GContact
* @param integer $cid Contact ID
* @param integer $zcid Global Contact ID
* @return void
* @throws Exception
*/
public static function link($gcid, $uid = 0, $cid = 0, $zcid = 0)
{
@ -105,16 +107,16 @@ class GContact
/**
* @brief Sanitize the given gcontact data
*
* @param array $gcontact array with gcontact data
* @throw Exception
*
* Generation:
* 0: No definition
* 1: Profiles on this server
* 2: Contacts of profiles on this server
* 3: Contacts of contacts of profiles on this server
* 4: ...
*
* @param array $gcontact array with gcontact data
* @return array $gcontact
* @throws Exception
*/
public static function sanitize($gcontact)
{
@ -412,6 +414,7 @@ class GContact
* @param integer $start optional, default 0
* @param integer $limit optional, default 80
* @return array
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function suggestionQuery($uid, $start = 0, $limit = 80)
{
@ -515,6 +518,7 @@ class GContact
/**
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function updateSuggestions()
{
@ -568,6 +572,7 @@ class GContact
* @param string $url Contact url
*
* @return string Contact url with the wanted parts
* @throws Exception
*/
public static function cleanContactUrl($url)
{
@ -599,6 +604,8 @@ class GContact
*
* @param array $contact contact array (called by reference)
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function fixAlternateContactAddress(&$contact)
{
@ -620,6 +627,8 @@ class GContact
* @param array $contact contact array
*
* @return bool|int Returns false if not found, integer if contact was found
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function getId($contact)
{
@ -715,6 +724,8 @@ class GContact
* @param array $contact contact array
*
* @return bool|int Returns false if not found, integer if contact was found
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function update($contact)
{
@ -879,6 +890,8 @@ class GContact
*
* @param string $url profile link
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function updateFromProbe($url)
{
@ -898,7 +911,9 @@ class GContact
* @brief Update the gcontact entry for a given user id
*
* @param int $uid User ID
* @return void
* @return bool
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function updateForUser($uid)
{
@ -949,7 +964,9 @@ class GContact
* If the "Statistics" addon is enabled (See http://gstools.org/ for details) we query user data with this.
*
* @param string $server Server address
* @return void
* @return bool
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function fetchGsUsers($server)
{
@ -1009,6 +1026,8 @@ class GContact
/**
* @brief Asking GNU Social server on a regular base for their user data
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function discoverGsUsers()
{