Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-05-12 05:04:10 +02:00
Code Issues Projects Releases Packages Wiki Activity

@brief is removed completely

Browse source
This commit is contained in:
Michael 2020-01-19 06:05:23 +00:00
parent fd1f1999f0
commit 0a4119adaf
170 changed files with 901 additions and 962 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/Content/ContactSelector.php
View file

@ -12,7 +12,7 @@ use Friendica\Util\Network;
use Friendica\Util\Strings;
/**
* @brief ContactSelector class
* ContactSelector class
*/
class ContactSelector
{

8
src/Content/Feature.php
View file

@ -1,7 +1,7 @@
<?php
/**
* @file src/Content/Feature.php
* @brief Features management
* Features management
*/
namespace Friendica\Content;
@ -13,7 +13,7 @@ use Friendica\DI;
class Feature
{
/**
* @brief check if feature is enabled
* check if feature is enabled
*
* @param integer $uid user id
* @param string $feature feature
@ -42,7 +42,7 @@ class Feature
}
/**
* @brief check if feature is enabled or disabled by default
* check if feature is enabled or disabled by default
*
* @param string $feature feature
* @return boolean
@ -62,7 +62,7 @@ class Feature
}
/**
* @brief Get a list of all available features
* Get a list of all available features
*
* The array includes the setting group, the setting name,
* explainations for the setting and if it's enabled or disabled

12
src/Content/ForumManager.php
View file

@ -1,7 +1,7 @@
<?php
/**
* @file src/Content/ForumManager.php
* @brief ForumManager class with its methods related to forum functionality
* ForumManager class with its methods related to forum functionality
*/
namespace Friendica\Content;
@ -15,12 +15,12 @@ use Friendica\Model\Contact;
use Friendica\Util\Proxy as ProxyUtils;
/**
* @brief This class handles methods related to the forum functionality
* This class handles methods related to the forum functionality
*/
class ForumManager
{
/**
* @brief Function to list all forums a user is connected with
* Function to list all forums a user is connected with
*
* @param int $uid of the profile owner
* @param boolean $lastitem Sort by lastitem
@ -80,7 +80,7 @@ class ForumManager
/**
* @brief Forumlist widget
* Forumlist widget
*
* Sidebar widget to show subcribed friendica forums. If activated
* in the settings, it appears at the notwork page sidebar
@ -140,7 +140,7 @@ class ForumManager
}
/**
* @brief Format forumlist as contact block
* Format forumlist as contact block
*
* This function is used to show the forumlist in
* the advanced profile.
@ -184,7 +184,7 @@ class ForumManager
}
/**
* @brief count unread forum items
* count unread forum items
*
* Count unread items of connected forums and private groups
*

1
src/Content/Nav.php
View file

@ -119,7 +119,6 @@ class Nav
/**
* Prepares a list of navigation links
*
* @brief Prepares a list of navigation links
* @param App $a
* @return array Navigation links
* string 'sitelocation' => The webbie (username@site.com)

11
src/Content/OEmbed.php
View file

@ -45,7 +45,7 @@ class OEmbed
}
/**
* @brief Get data from an URL to embed its content.
* Get data from an URL to embed its content.
*
* @param string $embedurl The URL from which the data should be fetched.
* @param bool $no_rich_type If set to true rich type content won't be fetched.
@ -297,7 +297,6 @@ class OEmbed
/**
* Determines if rich content OEmbed is allowed for the provided URL
*
* @brief Determines if rich content OEmbed is allowed for the provided URL
* @param string $url
* @return boolean
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -345,7 +344,7 @@ class OEmbed
}
/**
* @brief Generates the iframe HTML for an oembed attachment.
* Generates the iframe HTML for an oembed attachment.
*
* Width and height are given by the remote, and are regularly too small for
* the generated iframe.
@ -378,11 +377,11 @@ class OEmbed
}
/**
* Generates attribute search XPath string
*
* Generates an XPath query to select elements whose provided attribute contains
* the provided value in a space-separated list.
*
* @brief Generates attribute search XPath string
*
* @param string $attr Name of the attribute to seach
* @param string $value Value to search in a space-separated list
* @return string
@ -396,8 +395,6 @@ class OEmbed
/**
* Returns the inner XML string of a provided DOMNode
*
* @brief Returns the inner XML string of a provided DOMNode
*
* @param DOMNode $node
* @return string
*/

4
src/Content/Pager.php
View file

@ -124,7 +124,7 @@ class Pager
}
/**
* @brief Minimal pager (newer/older)
* Minimal pager (newer/older)
*
* This mode is intended for reverse chronological pages and presents only two links, newer (previous) and older (next).
* The itemCount is the number of displayed items. If no items are displayed, the older button is disabled.
@ -165,7 +165,7 @@ class Pager
}
/**
* @brief Full pager (first / prev / 1 / 2 / ... / 14 / 15 / next / last)
* Full pager (first / prev / 1 / 2 / ... / 14 / 15 / next / last)
*
* This mode presents page numbers as well as first, previous, next and last links.
* The itemCount is the total number of items including those not displayed.

9
src/Content/Smilies.php
View file

@ -2,7 +2,7 @@
/**
* @file src/Content/Smilies.php
* @brief This file contains the Smilies class which contains functions to handle smiles
* This file contains the Smilies class which contains functions to handle smiles
*
* @todo Use the shortcodes from here:
* https://github.com/iamcal/emoji-data/blob/master/emoji_pretty.json?raw=true
@ -26,7 +26,7 @@ use Friendica\Util\Strings;
class Smilies
{
/**
* @brief Replaces/adds the emoticon list
* Replaces/adds the emoticon list
*
* This function should be used whenever emoticons are added
*
@ -49,7 +49,7 @@ class Smilies
}
/**
* @brief Function to list all smilies
* Function to list all smilies
*
* Get an array of all smilies, both internal and from addons.
*
@ -179,7 +179,6 @@ class Smilies
* function from being executed by the prepare_text() routine when preparing
* bbcode source for HTML display
*
* @brief Replaces text emoticons with graphical images
* @param string $s Text that should be replaced
* @param boolean $no_images Only replace emoticons without images
*
@ -261,7 +260,7 @@ class Smilies
/**
* @brief expand <3333 to the correct number of hearts
* expand <3333 to the correct number of hearts
*
* @param string $x string
*

25
src/Content/Text/BBCode.php
View file

@ -35,7 +35,7 @@ use Friendica\Util\XML;
class BBCode
{
/**
* @brief Fetches attachment data that were generated the old way
* Fetches attachment data that were generated the old way
*
* @param string $body Message body
* @return array
@ -106,7 +106,7 @@ class BBCode
}
/**
* @brief Fetches attachment data that were generated with the "attachment" element
* Fetches attachment data that were generated with the "attachment" element
*
* @param string $body Message body
* @return array
@ -411,7 +411,7 @@ class BBCode
}
/**
* @brief Converts a BBCode text into plaintext
* Converts a BBCode text into plaintext
*
* @param $text
* @param bool $keep_urls Whether to keep URLs in the resulting plaintext
@ -486,10 +486,11 @@ class BBCode
}
/**
* Truncates imported message body string length to max_import_size
*
* The purpose of this function is to apply system message length limits to
* imported messages without including any embedded photos in the length
*
* @brief Truncates imported message body string length to max_import_size
* @param string $body
* @return string
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -578,7 +579,6 @@ class BBCode
*
* Note: Can produce a [bookmark] tag in the returned string
*
* @brief Processes [attachment] tags
* @param string $text
* @param bool|int $simplehtml
* @param bool $tryoembed
@ -691,7 +691,6 @@ class BBCode
/**
* Converts [url] BBCodes in a format that looks fine on Mastodon. (callback function)
*
* @brief Converts [url] BBCodes in a format that looks fine on Mastodon. (callback function)
* @param array $match Array with the matching values
* @return string reformatted link including HTML codes
*/
@ -712,7 +711,7 @@ class BBCode
}
/**
* @brief Converts [url] BBCodes in a format that looks fine on ActivityPub systems.
* Converts [url] BBCodes in a format that looks fine on ActivityPub systems.
* @param string $url URL that is about to be reformatted
* @return string reformatted link including HTML codes
*/
@ -1206,7 +1205,7 @@ class BBCode
}
/**
* @brief Converts a BBCode message to HTML message
* Converts a BBCode message to HTML message
*
* BBcode 2 HTML was written by WAY2WEB.net
* extended to work with Mistpark/Friendica - Mike Macgirvin
@ -1906,7 +1905,7 @@ class BBCode
}
/**
* @brief Strips the "abstract" tag from the provided text
* Strips the "abstract" tag from the provided text
*
* @param string $text The text with BBCode
* @return string The same text - but without "abstract" element
@ -1920,7 +1919,7 @@ class BBCode
}
/**
* @brief Returns the value of the "abstract" element
* Returns the value of the "abstract" element
*
* @param string $text The text that maybe contains the element
* @param string $addon The addon for which the abstract is meant for
@ -1950,7 +1949,7 @@ class BBCode
}
/**
* @brief Callback function to replace a Friendica style mention in a mention for Diaspora
* Callback function to replace a Friendica style mention in a mention for Diaspora
*
* @param array $match Matching values for the callback
* [1] = Mention type (! or @)
@ -1977,7 +1976,7 @@ class BBCode
}
/**
* @brief Converts a BBCode text into Markdown
* Converts a BBCode text into Markdown
*
* This function converts a BBCode item body to be sent to Markdown-enabled
* systems like Diaspora and Libertree
@ -2064,7 +2063,7 @@ class BBCode
}
/**
* @brief Pull out all #hashtags and @person tags from $string.
* Pull out all #hashtags and @person tags from $string.
*
* We also get @person@domain.com - which would make
* the regex quite complicated as tags can also

11
src/Content/Text/HTML.php
View file

@ -137,11 +137,12 @@ class HTML
}
/**
* Converter for HTML to BBCode
*
* Made by: ike@piratenpartei.de
* Originally made for the syncom project: http://wiki.piratenpartei.de/Syncom
* https://github.com/annando/Syncom
*
* @brief Converter for HTML to BBCode
* @param string $message
* @param string $basepath
* @return string
@ -411,7 +412,7 @@ class HTML
}
/**
* @brief Sub function to complete incomplete URL
* Sub function to complete incomplete URL
*
* @param array $matches Result of preg_replace_callback
* @param string $basepath Basepath that is used to complete the URL
@ -438,7 +439,7 @@ class HTML
}
/**
* @brief Complete incomplete URLs in BBCode
* Complete incomplete URLs in BBCode
*
* @param string $body Body with URLs
* @param string $basepath Base path that is used to complete the URL
@ -710,7 +711,7 @@ class HTML
}
/**
* @brief Convert video HTML to BBCode tags
* Convert video HTML to BBCode tags
*
* @param string $s
* @return string
@ -820,7 +821,7 @@ class HTML
}
/**
* @brief Format contacts as picture links or as text links
* Format contacts as picture links or as text links
*
* @param array $contact Array with contacts which contains an array with
* int 'id' => The ID of the contact

3
src/Content/Text/Markdown.php
View file

@ -21,7 +21,6 @@ class Markdown
* Converts a Markdown string into HTML. The hardwrap parameter maximizes
* compatibility with Diaspora in spite of the Markdown standard.
*
* @brief Converts a Markdown string into HTML
* @param string $text
* @param bool $hardwrap
* @return string
@ -49,7 +48,7 @@ class Markdown
}
/**
* @brief Callback function to replace a Diaspora style mention in a mention for Friendica
* Callback function to replace a Diaspora style mention in a mention for Friendica
*
* @param array $match Matching values for the callback
* [1] = mention type (@ or !)

1
src/Content/Widget.php
View file

@ -411,7 +411,6 @@ class Widget
/**
* Insert a tag cloud widget for the present profile.
*
* @brief Insert a tag cloud widget for the present profile.
* @param int $limit Max number of displayed tags.
* @return string HTML formatted output.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException

2
src/Content/Widget/CalendarExport.php
View file

@ -19,7 +19,7 @@ use Friendica\DI;
class CalendarExport
{
/**
* @brief Get the events widget.
* Get the events widget.
*
* @return string Formated HTML of the calendar widget.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException

5
src/Content/Widget/TagCloud.php
View file

@ -22,7 +22,6 @@ class TagCloud
/**
* Construct a tag/term cloud block for an user.
*
* @brief Construct a tag/term cloud block for an user.
* @param int $uid The user ID.
* @param int $count Max number of displayed tags/terms.
* @param int $owner_id The contact ID of the owner of the tagged items.
@ -62,8 +61,6 @@ class TagCloud
* Get alphabetical sorted array of used tags/terms of an user including
* a weighting by frequency of use.
*
* @brief Get alphabetical sorted array of used tags/terms of an user including
* a weighting by frequency of use.
* @param int $uid The user ID.
* @param int $count Max number of displayed tags/terms.
* @param int $owner_id The contact id of the owner of the tagged items.
@ -112,7 +109,6 @@ class TagCloud
/**
* Calculate weighting of tags according to the frequency of use.
*
* @brief Calculate weighting of tags according to the frequency of use.
* @param array $arr Array of tags/terms with tag/term name and total count of use.
* @return array Alphabetical sorted array of used tags/terms of an user.
*/
@ -149,7 +145,6 @@ class TagCloud
/**
* Compare function to sort tags/terms alphabetically.
*
* @brief Compare function to sort tags/terms alphabetically.
* @param string $a
* @param string $b
*