From 0a4119adaf6294bf43d135a0f435c1dd677c50e0 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 19 Jan 2020 06:05:23 +0000 Subject: [PATCH 1/5] @brief is removed completely --- bin/worker.php | 2 +- boot.php | 18 +-- include/api.php | 104 +++++------- include/conversation.php | 28 ++-- include/dba.php | 2 +- include/enotify.php | 8 +- mod/cal.php | 7 +- mod/dfrn_confirm.php | 3 +- mod/dfrn_notify.php | 2 +- mod/dfrn_request.php | 2 +- mod/events.php | 2 +- mod/match.php | 2 +- mod/network.php | 12 +- mod/notifications.php | 2 +- mod/parse_url.php | 4 +- mod/ping.php | 6 +- mod/uimport.php | 2 +- mod/wall_upload.php | 2 +- mod/worker.php | 2 +- src/App.php | 4 +- src/App/Authentication.php | 4 +- src/BaseModule.php | 10 +- src/Console/ArchiveContact.php | 2 +- src/Console/Cache.php | 2 +- src/Console/Config.php | 2 +- src/Console/CreateDoxygen.php | 4 +- src/Console/DatabaseStructure.php | 2 +- src/Console/GlobalCommunityBlock.php | 2 +- src/Console/GlobalCommunitySilence.php | 2 +- src/Console/Lock.php | 2 +- src/Console/Maintenance.php | 2 +- src/Console/NewPassword.php | 2 +- src/Console/ServerBlock.php | 2 +- src/Console/Storage.php | 2 +- src/Content/ContactSelector.php | 2 +- src/Content/Feature.php | 8 +- src/Content/ForumManager.php | 12 +- src/Content/Nav.php | 1 - src/Content/OEmbed.php | 11 +- src/Content/Pager.php | 4 +- src/Content/Smilies.php | 9 +- src/Content/Text/BBCode.php | 25 ++- src/Content/Text/HTML.php | 11 +- src/Content/Text/Markdown.php | 3 +- src/Content/Widget.php | 1 - src/Content/Widget/CalendarExport.php | 2 +- src/Content/Widget/TagCloud.php | 5 - src/Core/Addon.php | 8 +- src/Core/Config.php | 13 +- src/Core/Config/IConfiguration.php | 8 +- src/Core/Hook.php | 10 +- src/Core/L10n.php | 10 +- src/Core/L10n/L10n.php | 6 +- src/Core/Logger.php | 9 +- src/Core/Process.php | 6 +- src/Core/Renderer.php | 18 +-- src/Core/Search.php | 1 - src/Core/Session/Handler/Cache.php | 2 +- src/Core/Session/Handler/Database.php | 2 +- src/Core/StorageManager.php | 14 +- src/Core/System.php | 14 +- src/Core/Theme.php | 8 +- src/Core/Update.php | 2 +- src/Core/UserImport.php | 4 +- src/Core/Worker.php | 57 +++---- src/Database/DBA.php | 6 +- src/Database/DBStructure.php | 4 +- src/Database/Database.php | 70 ++++----- src/Database/PostUpdate.php | 12 +- src/Factory/LockFactory.php | 2 +- src/Model/Attach.php | 24 +-- src/Model/Contact.php | 84 +++++----- src/Model/Conversation.php | 2 +- src/Model/Event.php | 30 ++-- src/Model/FileTag.php | 18 +-- src/Model/GContact.php | 32 ++-- src/Model/Group.php | 26 +-- src/Model/Item.php | 70 ++++----- src/Model/ItemContent.php | 2 +- src/Model/ItemURI.php | 4 +- src/Model/Notify.php | 16 +- src/Model/PermissionSet.php | 4 +- src/Model/Photo.php | 28 ++-- src/Model/Process.php | 2 +- src/Model/Profile.php | 13 +- src/Model/PushSubscriber.php | 10 +- src/Model/Storage/Database.php | 4 +- src/Model/Storage/Filesystem.php | 8 +- src/Model/Storage/IStorage.php | 14 +- src/Model/Storage/StorageException.php | 4 +- src/Model/Storage/SystemResource.php | 4 +- src/Model/User.php | 24 +-- src/Module/Admin/Queue.php | 2 +- src/Module/Attach.php | 4 +- src/Module/Base/Api.php | 5 +- src/Module/Contact.php | 6 +- src/Module/Feed.php | 2 - src/Module/Owa.php | 2 +- src/Module/Photo.php | 4 +- src/Module/Proxy.php | 16 +- src/Module/Register.php | 4 +- src/Module/Security/Login.php | 2 +- src/Module/Security/Logout.php | 2 +- src/Module/Tos.php | 6 +- src/Network/FKOAuth1.php | 4 +- src/Network/FKOAuthDataStore.php | 2 +- src/Network/Probe.php | 50 +++--- src/Object/Image.php | 14 +- src/Protocol/ActivityPub.php | 3 +- src/Protocol/ActivityPub/Receiver.php | 2 +- src/Protocol/ActivityPub/Transmitter.php | 4 +- src/Protocol/DFRN.php | 66 ++++---- src/Protocol/Diaspora.php | 166 ++++++++++---------- src/Protocol/Email.php | 2 +- src/Protocol/Feed.php | 6 +- src/Protocol/OStatus.php | 70 ++++----- src/Protocol/PortableContact.php | 8 +- src/Protocol/Salmon.php | 3 +- src/Util/Arrays.php | 4 +- src/Util/BasePath.php | 4 +- src/Util/Crypto.php | 2 +- src/Util/DateTimeFormat.php | 4 +- src/Util/Emailer.php | 2 +- src/Util/ExAuth.php | 18 +-- src/Util/HTTPSignature.php | 16 +- src/Util/JsonLD.php | 12 +- src/Util/LDSignature.php | 2 +- src/Util/Network.php | 23 ++- src/Util/ParseUrl.php | 16 +- src/Util/Pidfile.php | 12 +- src/Util/Proxy.php | 14 +- src/Util/Strings.php | 26 +-- src/Util/Temporal.php | 26 +-- src/Util/XML.php | 16 +- src/Worker/APDelivery.php | 2 +- src/Worker/CheckVersion.php | 4 +- src/Worker/CreateShadowEntry.php | 2 +- src/Worker/Cron.php | 4 +- src/Worker/CronJobs.php | 10 +- src/Worker/DBClean.php | 6 +- src/Worker/DBUpdate.php | 2 +- src/Worker/Delivery.php | 6 +- src/Worker/Directory.php | 2 +- src/Worker/Expire.php | 2 +- src/Worker/OnePoll.php | 8 +- src/Worker/ProfileUpdate.php | 2 +- src/Worker/RemoveContact.php | 2 +- src/Worker/RemoveUser.php | 2 +- src/Worker/SpoolPost.php | 2 +- tests/Util/Database/StaticDatabase.php | 2 +- tests/src/Util/ACLFormaterTest.php | 2 +- tests/src/Util/ArraysTest.php | 24 +-- tests/src/Util/StringsTest.php | 2 +- tests/src/Util/XmlTest.php | 2 +- view/js/autocomplete.js | 2 +- view/php/none.php | 2 +- view/theme/frio/css/font-awesome.custom.css | 4 +- view/theme/frio/js/mod_admin.js | 2 +- view/theme/frio/js/mod_contacts.js | 2 +- view/theme/frio/js/mod_display.js | 2 +- view/theme/frio/js/mod_events.js | 2 +- view/theme/frio/js/mod_group.js | 8 +- view/theme/frio/js/mod_notifications.js | 2 +- view/theme/frio/js/modal.js | 4 +- view/theme/frio/js/textedit.js | 2 +- view/theme/frio/php/Image.php | 6 +- view/theme/frio/php/default.php | 2 +- view/theme/frio/php/frio_boot.php | 14 +- view/theme/frio/php/standard.php | 2 +- view/theme/frio/theme.php | 10 +- 170 files changed, 901 insertions(+), 962 deletions(-) diff --git a/bin/worker.php b/bin/worker.php index b2d97cc11..3510f9905 100755 --- a/bin/worker.php +++ b/bin/worker.php @@ -2,7 +2,7 @@ \r\n"); /** - * @brief Image storage quality. + * Image storage quality. * * Lower numbers save space at cost of image detail. * For ease of upgrade, please do not change here. Set system.jpegquality = n in config/local.config.php, @@ -233,7 +233,7 @@ if (!defined('CURLE_OPERATION_TIMEDOUT')) { } /** - * @brief Returns the user id of locally logged in user or false. + * Returns the user id of locally logged in user or false. * * @return int|bool user id or false */ @@ -246,7 +246,7 @@ function local_user() } /** - * @brief Returns the public contact id of logged in user or false. + * Returns the public contact id of logged in user or false. * * @return int|bool public contact id or false */ @@ -270,7 +270,7 @@ function public_contact() } /** - * @brief Returns contact id of authenticated site visitor or false + * Returns contact id of authenticated site visitor or false * * @return int|bool visitor_id or false */ @@ -288,7 +288,7 @@ function remote_user() } /** - * @brief Show an error message to user. + * Show an error message to user. * * This function save text in session, to be shown to the user at next page load * @@ -310,7 +310,7 @@ function notice($s) } /** - * @brief Show an info message to user. + * Show an info message to user. * * This function save text in session, to be shown to the user at next page load * @@ -375,7 +375,7 @@ function feed_birthday($uid, $tz) } /** - * @brief Check if current user has admin role. + * Check if current user has admin role. * * @return bool true if user is an admin */ @@ -571,7 +571,7 @@ function get_itemcachepath() } /** - * @brief Returns the path where spool files are stored + * Returns the path where spool files are stored * * @return string Spool path */ diff --git a/include/api.php b/include/api.php index 8220e7bb1..e4464a2c7 100644 --- a/include/api.php +++ b/include/api.php @@ -65,11 +65,11 @@ $API = []; $called_api = []; /** + * Auth API user + * * It is not sufficient to use local_user() to check whether someone is allowed to use the API, * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF * into a page, and visitors will post something without noticing it). - * - * @brief Auth API user */ function api_user() { @@ -81,13 +81,13 @@ function api_user() } /** + * Get source name from API client + * * Clients can send 'source' parameter to be show in post metadata * as "sent via ". * Some clients doesn't send a source param, we support ones we know * (only Twidere, atm) * - * @brief Get source name from API client - * * @return string * Client source name, default to "api" if unset/unknown * @throws Exception @@ -113,7 +113,7 @@ function api_source() } /** - * @brief Format date for API + * Format date for API * * @param string $str Source date, as UTC * @return string Date in UTC formatted as "D M d H:i:s +0000 Y" @@ -128,8 +128,6 @@ function api_date($str) /** * Register a function to be the endpoint for defined API path. * - * @brief Register API endpoint - * * @param string $path API URL path, relative to DI::baseUrl() * @param string $func Function name to call on path request * @param bool $auth API need logged user @@ -161,8 +159,6 @@ function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY * Log in user via OAuth1 or Simple HTTP Auth. * Simple Auth allow username in form of 
user@server
, ignoring server part * - * @brief Login API user - * * @param App $a App * @throws ForbiddenException * @throws InternalServerErrorException @@ -260,12 +256,12 @@ function api_login(App $a) } /** + * Check HTTP method of called API + * * API endpoints can define which HTTP method to accept when called. * This function check the current HTTP method agains endpoint * registered method. * - * @brief Check HTTP method of called API - * * @param string $method Required methods, uppercase, separated by comma * @return bool */ @@ -278,9 +274,9 @@ function api_check_method($method) } /** - * Authenticate user, call registered API function, set HTTP headers + * Main API entry point * - * @brief Main API entry point + * Authenticate user, call registered API function, set HTTP headers * * @param App $a App * @param App\Arguments $args The app arguments (optional, will retrieved by the DI-Container in case of missing) @@ -379,7 +375,7 @@ function api_call(App $a, App\Arguments $args = null) } /** - * @brief Format API error string + * Format API error string * * @param string $type Return type (xml, json, rss, as) * @param object $e HTTPException Error object @@ -417,7 +413,7 @@ function api_error($type, $e, App\Arguments $args) } /** - * @brief Set values for RSS template + * Set values for RSS template * * @param App $a * @param array $arr Array to be passed to template @@ -451,7 +447,7 @@ function api_rss_extra(App $a, $arr, $user_info) /** - * @brief Unique contact to contact url. + * Unique contact to contact url. * * @param int $id Contact id * @return bool|string @@ -470,7 +466,7 @@ function api_unique_id_to_nurl($id) } /** - * @brief Get user info array. + * Get user info array. * * @param App $a App * @param int|string $contact_id Contact ID or URL @@ -759,7 +755,7 @@ function api_get_user(App $a, $contact_id = null) } /** - * @brief return api-formatted array for item's author and owner + * return api-formatted array for item's author and owner * * @param App $a App * @param array $item item from db @@ -787,7 +783,7 @@ function api_item_get_user(App $a, $item) } /** - * @brief walks recursively through an array with the possibility to change value and key + * walks recursively through an array with the possibility to change value and key * * @param array $array The array to walk through * @param callable $callback The callback function @@ -815,7 +811,7 @@ function api_walk_recursive(array &$array, callable $callback) } /** - * @brief Callback function to transform the array in an array that can be transformed in a XML file + * Callback function to transform the array in an array that can be transformed in a XML file * * @param mixed $item Array item value * @param string $key Array key @@ -841,7 +837,7 @@ function api_reformat_xml(&$item, &$key) } /** - * @brief Creates the XML from a JSON style array + * Creates the XML from a JSON style array * * @param array $data JSON style array * @param string $root_element Name of the root element @@ -886,7 +882,7 @@ function api_create_xml(array $data, $root_element) } /** - * @brief Formats the data according to the data type + * Formats the data according to the data type * * @param string $root_element Name of the root element * @param string $type Return type (atom, rss, xml, json) @@ -1777,8 +1773,6 @@ api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline' /** * Returns the most recent statuses posted by users this node knows about. * - * @brief Returns the list of public federated posts this node knows about - * * @param string $type Return format: json, xml, atom, rss * @return array|string * @throws BadRequestException @@ -2209,8 +2203,6 @@ api_register_func('api/statuses/replies', 'api_statuses_mentions', true); /** * Returns the most recent statuses posted by the user. * - * @brief Returns a user's public timeline - * * @param string $type Either "json" or "xml" * @return string|array * @throws BadRequestException @@ -2812,7 +2804,7 @@ function api_format_items_embeded_images($item, $text) } /** - * @brief return name as array + * return name as array * * @param string $txt text * @return array @@ -2839,7 +2831,7 @@ function api_contactlink_to_array($txt) /** - * @brief return likes, dislikes and attend status for item + * return likes, dislikes and attend status for item * * @param array $item array * @param string $type Return type (atom, rss, xml, json) @@ -2919,7 +2911,7 @@ function api_format_items_activities($item, $type = "json") /** - * @brief return data from profiles + * return data from profiles * * @param array $profile_row array containing data from db table 'profile' * @return array @@ -2972,7 +2964,7 @@ function api_format_items_profiles($profile_row) } /** - * @brief format items to be returned by api + * format items to be returned by api * * @param array $items array of items * @param array $user_info @@ -3387,11 +3379,11 @@ function api_lists_statuses($type) api_register_func('api/lists/statuses', 'api_lists_statuses', true); /** + * Returns either the friends of the follower list + * * Considers friends and followers lists to be private and won't return * anything if any user_id parameter is passed. * - * @brief Returns either the friends of the follower list - * * @param string $qtype Either "friends" or "followers" * @return boolean|array * @throws BadRequestException @@ -3478,9 +3470,7 @@ function api_statuses_f($qtype) /** - * Returns the user's friends. - * - * @brief Returns the list of friends of the provided user + * Returns the list of friends of the provided user * * @deprecated By Twitter API in favor of friends/list * @@ -3499,9 +3489,7 @@ function api_statuses_friends($type) } /** - * Returns the user's followers. - * - * @brief Returns the list of followers of the provided user + * Returns the list of followers of the provided user * * @deprecated By Twitter API in favor of friends/list * @@ -3818,9 +3806,7 @@ function api_direct_messages_new($type) api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST); /** - * Destroys a direct message. - * - * @brief delete a direct_message from mail table through api + * delete a direct_message from mail table through api * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -3906,8 +3892,6 @@ api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', /** * Unfollow Contact * - * @brief unfollow contact - * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array * @throws BadRequestException @@ -4203,7 +4187,7 @@ api_register_func('api/oauth/access_token', 'api_oauth_access_token', false); /** - * @brief delete a complete photoalbum with all containing photos from database through api + * delete a complete photoalbum with all containing photos from database through api * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -4258,7 +4242,7 @@ function api_fr_photoalbum_delete($type) } /** - * @brief update the name of the album for all photos of an album + * update the name of the album for all photos of an album * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -4300,7 +4284,7 @@ function api_fr_photoalbum_update($type) /** - * @brief list all photos of the authenticated user + * list all photos of the authenticated user * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -4348,7 +4332,7 @@ function api_fr_photos_list($type) } /** - * @brief upload a new photo or change an existing photo + * upload a new photo or change an existing photo * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -4487,7 +4471,7 @@ function api_fr_photo_create_update($type) } /** - * @brief delete a single photo from the database through api + * delete a single photo from the database through api * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -4540,7 +4524,7 @@ function api_fr_photo_delete($type) /** - * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64 + * returns the details of a specified photo id, if scale is given, returns the photo data in base 64 * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -4569,9 +4553,7 @@ function api_fr_photo_detail($type) /** - * Updates the user’s profile image. - * - * @brief updates the profile image for the user (either a specified profile or the default profile) + * updates the profile image for the user (either a specified profile or the default profile) * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @@ -5180,7 +5162,7 @@ function api_get_announce($item) } /** - * @brief Return the item shared, if the item contains only the [share] tag + * Return the item shared, if the item contains only the [share] tag * * @param array $item Sharer item * @return array|false Shared item or false if not a reshare @@ -5907,7 +5889,7 @@ api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST); /** - * @brief Returns notifications + * Returns notifications * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -5941,9 +5923,9 @@ function api_friendica_notification($type) } /** - * POST request with 'id' param as notification id + * Set notification as seen and returns associated item (if possible) * - * @brief Set notification as seen and returns associated item (if possible) + * POST request with 'id' param as notification id * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -5993,7 +5975,7 @@ api_register_func('api/friendica/notification/seen', 'api_friendica_notification api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET); /** - * @brief update a direct_message to seen state + * update a direct_message to seen state * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array (success result=ok, error result=error with error message) @@ -6044,7 +6026,7 @@ function api_friendica_direct_messages_setseen($type) api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true); /** - * @brief search for direct_messages containing a searchstring through api + * search for direct_messages containing a searchstring through api * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @param string $box @@ -6115,7 +6097,7 @@ function api_friendica_direct_messages_search($type, $box = "") api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true); /** - * @brief return data of all the profiles a user has to the client + * return data of all the profiles a user has to the client * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array @@ -6221,9 +6203,9 @@ function api_saved_searches_list($type) api_register_func('api/saved_searches/list', 'api_saved_searches_list', true); /* - * Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search + * Number of comments * - * @brief Number of comments + * Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search * * @param object $data [Status, Status] * diff --git a/include/conversation.php b/include/conversation.php index 5c1b140f4..990c72e05 100644 --- a/include/conversation.php +++ b/include/conversation.php @@ -837,7 +837,7 @@ function conversation_fetch_comments($thread_items, $pinned) { } /** - * @brief Add comments to top level entries that had been fetched before + * Add comments to top level entries that had been fetched before * * The system will fetch the comments for the local user whenever possible. * This behaviour is currently needed to allow commenting on Friendica posts. @@ -987,7 +987,8 @@ function item_photo_menu($item) { } /** - * @brief Checks item to see if it is one of the builtin activities (like/dislike, event attendance, consensus items, etc.) + * Checks item to see if it is one of the builtin activities (like/dislike, event attendance, consensus items, etc.) + * * Increments the count of each matching activity and adds a link to the author as needed. * * @param array $item @@ -1281,8 +1282,6 @@ function status_editor(App $a, $x, $notes_cid = 0, $popup = false) /** * Plucks the children of the given parent from a given item list. * - * @brief Plucks all the children in the given item list of the given parent - * * @param array $item_list * @param array $parent * @param bool $recursive @@ -1315,7 +1314,7 @@ function get_item_children(array &$item_list, array $parent, $recursive = true) } /** - * @brief Recursively sorts a tree-like item array + * Recursively sorts a tree-like item array * * @param array $items * @return array @@ -1333,7 +1332,7 @@ function sort_item_children(array $items) } /** - * @brief Recursively add all children items at the top level of a list + * Recursively add all children items at the top level of a list * * @param array $children List of items to append * @param array $item_list @@ -1349,6 +1348,8 @@ function add_children_to_list(array $children, array &$item_list) } /** + * Selectively flattens a tree-like item structure to prevent threading stairs + * * This recursive function takes the item tree structure created by conv_sort() and * flatten the extraneous depth levels when people reply sequentially, removing the * stairs effect in threaded conversations limiting the available content width. @@ -1359,8 +1360,6 @@ function add_children_to_list(array $children, array &$item_list) * This process is rendered somewhat more complicated because items can be either * replies or likes, and these don't factor at all in the reply count/last reply. * - * @brief Selectively flattens a tree-like item structure to prevent threading stairs - * * @param array $parent A tree-like array of items * @return array */ @@ -1407,12 +1406,11 @@ function smart_flatten_conversation(array $parent) /** - * Expands a flat list of items into corresponding tree-like conversation structures, + * Expands a flat list of items into corresponding tree-like conversation structures. + * * sort the top-level posts either on "received" or "commented", and finally * append all the items at the top level (???) * - * @brief Expands a flat item list into a conversation array for display - * * @param array $item_list A list of items belonging to one or more conversations * @param string $order Either on "received" or "commented" * @return array @@ -1486,7 +1484,7 @@ function conv_sort(array $item_list, $order) } /** - * @brief usort() callback to sort item arrays by pinned and the received key + * usort() callback to sort item arrays by pinned and the received key * * @param array $a * @param array $b @@ -1504,7 +1502,7 @@ function sort_thr_pinned_received(array $a, array $b) } /** - * @brief usort() callback to sort item arrays by the received key + * usort() callback to sort item arrays by the received key * * @param array $a * @param array $b @@ -1516,7 +1514,7 @@ function sort_thr_received(array $a, array $b) } /** - * @brief usort() callback to reverse sort item arrays by the received key + * usort() callback to reverse sort item arrays by the received key * * @param array $a * @param array $b @@ -1528,7 +1526,7 @@ function sort_thr_received_rev(array $a, array $b) } /** - * @brief usort() callback to sort item arrays by the commented key + * usort() callback to sort item arrays by the commented key * * @param array $a * @param array $b diff --git a/include/dba.php b/include/dba.php index c56f63a84..a90ec26fb 100644 --- a/include/dba.php +++ b/include/dba.php @@ -3,7 +3,7 @@ use Friendica\Database\DBA; /** - * @brief execute SQL query with printf style args - deprecated + * execute SQL query with printf style args - deprecated * * Please use the DBA:: functions instead: * DBA::select, DBA::exists, DBA::insert diff --git a/include/enotify.php b/include/enotify.php index 58c01827c..3785caab1 100644 --- a/include/enotify.php +++ b/include/enotify.php @@ -23,7 +23,7 @@ use Friendica\Util\Emailer; use Friendica\Util\Strings; /** - * @brief Creates a notification entry and possibly sends a mail + * Creates a notification entry and possibly sends a mail * * @param array $params Array with the elements: * uid, item, parent, type, otype, verb, event, @@ -652,7 +652,7 @@ function notification($params) } /** - * @brief Checks for users who should be notified + * Checks for users who should be notified * * @param int $itemid ID of the item for which the check should be done * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -667,7 +667,7 @@ function check_user_notification($itemid) { } /** - * @brief Checks for item related notifications and sends them + * Checks for item related notifications and sends them * * @param int $itemid ID of the item for which the check should be done * @param int $uid User ID @@ -738,7 +738,7 @@ function check_item_notification($itemid, $uid, $notification_type) { } /** - * @brief Formats a notification message with the notification author + * Formats a notification message with the notification author * * Replace the name with {0} but ensure to make that only once. The {0} is used * later and prints the name in bold. diff --git a/mod/cal.php b/mod/cal.php index c388e9521..86a762af8 100644 --- a/mod/cal.php +++ b/mod/cal.php @@ -1,9 +1,10 @@ */ diff --git a/src/Console/GlobalCommunityBlock.php b/src/Console/GlobalCommunityBlock.php index 1789b66d9..77be530da 100644 --- a/src/Console/GlobalCommunityBlock.php +++ b/src/Console/GlobalCommunityBlock.php @@ -7,7 +7,7 @@ use Friendica\Core\L10n; use Friendica\Model\Contact; /** - * @brief tool to block an account from the node + * tool to block an account from the node * * With this tool, you can block an account in such a way, that no postings * or comments this account writes are accepted to the node. diff --git a/src/Console/GlobalCommunitySilence.php b/src/Console/GlobalCommunitySilence.php index 58feb4507..f944fcbe2 100644 --- a/src/Console/GlobalCommunitySilence.php +++ b/src/Console/GlobalCommunitySilence.php @@ -8,7 +8,7 @@ use Friendica\Model\Contact; use RuntimeException; /** - * @brief tool to silence accounts on the global community page + * tool to silence accounts on the global community page * * With this tool, you can silence an account on the global community page. * Postings from silenced accounts will not be displayed on the community diff --git a/src/Console/Lock.php b/src/Console/Lock.php index da1f408d0..2ab383c1e 100644 --- a/src/Console/Lock.php +++ b/src/Console/Lock.php @@ -8,7 +8,7 @@ use Friendica\Core\Lock\ILock; use RuntimeException; /** - * @brief tool to access the locks from the CLI + * tool to access the locks from the CLI * * With this script you can access the locks of your node from the CLI. * You can read current locks and set/remove locks. diff --git a/src/Console/Maintenance.php b/src/Console/Maintenance.php index 9633a50e9..8e26f3256 100644 --- a/src/Console/Maintenance.php +++ b/src/Console/Maintenance.php @@ -6,7 +6,7 @@ use Friendica\App; use Friendica\Core\Config\IConfiguration; /** - * @brief Sets maintenance mode for this node + * Sets maintenance mode for this node * * @author Hypolite Petovan */ diff --git a/src/Console/NewPassword.php b/src/Console/NewPassword.php index e19fd03ba..caa0aac7d 100644 --- a/src/Console/NewPassword.php +++ b/src/Console/NewPassword.php @@ -9,7 +9,7 @@ use Friendica\Model\User; use RuntimeException; /** - * @brief tool to set a new password for a user + * tool to set a new password for a user * * With this tool, you can set a new password for a user * diff --git a/src/Console/ServerBlock.php b/src/Console/ServerBlock.php index f94c24dbd..a8a75327c 100644 --- a/src/Console/ServerBlock.php +++ b/src/Console/ServerBlock.php @@ -8,7 +8,7 @@ use Console_Table; use Friendica\Core\Config\IConfiguration; /** - * @brief Manage blocked servers + * Manage blocked servers * * With this tool, you can list the current blocked servers * or you can add / remove a blocked server from the list diff --git a/src/Console/Storage.php b/src/Console/Storage.php index 731dc79e5..30a7fc713 100644 --- a/src/Console/Storage.php +++ b/src/Console/Storage.php @@ -6,7 +6,7 @@ use Asika\SimpleConsole\CommandArgsException; use Friendica\Core\StorageManager; /** - * @brief tool to manage storage backend and stored data from CLI + * tool to manage storage backend and stored data from CLI * */ class Storage extends \Asika\SimpleConsole\Console diff --git a/src/Content/ContactSelector.php b/src/Content/ContactSelector.php index ee1f0ca84..faba6269f 100644 --- a/src/Content/ContactSelector.php +++ b/src/Content/ContactSelector.php @@ -12,7 +12,7 @@ use Friendica\Util\Network; use Friendica\Util\Strings; /** - * @brief ContactSelector class + * ContactSelector class */ class ContactSelector { diff --git a/src/Content/Feature.php b/src/Content/Feature.php index 995f33292..af821e6c7 100644 --- a/src/Content/Feature.php +++ b/src/Content/Feature.php @@ -1,7 +1,7 @@ The webbie (username@site.com) diff --git a/src/Content/OEmbed.php b/src/Content/OEmbed.php index 18a8acb0f..64182c70e 100644 --- a/src/Content/OEmbed.php +++ b/src/Content/OEmbed.php @@ -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 */ diff --git a/src/Content/Pager.php b/src/Content/Pager.php index c12608d45..327272e28 100644 --- a/src/Content/Pager.php +++ b/src/Content/Pager.php @@ -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. diff --git a/src/Content/Smilies.php b/src/Content/Smilies.php index cafc6f314..1dd40e163 100644 --- a/src/Content/Smilies.php +++ b/src/Content/Smilies.php @@ -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 * diff --git a/src/Content/Text/BBCode.php b/src/Content/Text/BBCode.php index 19ff88a9c..cdb48215c 100644 --- a/src/Content/Text/BBCode.php +++ b/src/Content/Text/BBCode.php @@ -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 diff --git a/src/Content/Text/HTML.php b/src/Content/Text/HTML.php index 557e73709..65d971489 100644 --- a/src/Content/Text/HTML.php +++ b/src/Content/Text/HTML.php @@ -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 diff --git a/src/Content/Text/Markdown.php b/src/Content/Text/Markdown.php index 632282dff..16a2ce307 100644 --- a/src/Content/Text/Markdown.php +++ b/src/Content/Text/Markdown.php @@ -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 !) diff --git a/src/Content/Widget.php b/src/Content/Widget.php index 74955be02..2ae90ea76 100644 --- a/src/Content/Widget.php +++ b/src/Content/Widget.php @@ -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 diff --git a/src/Content/Widget/CalendarExport.php b/src/Content/Widget/CalendarExport.php index a6fea1e8a..ff3d3f4b8 100644 --- a/src/Content/Widget/CalendarExport.php +++ b/src/Content/Widget/CalendarExport.php @@ -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 diff --git a/src/Content/Widget/TagCloud.php b/src/Content/Widget/TagCloud.php index 15ed41a35..b29e62780 100644 --- a/src/Content/Widget/TagCloud.php +++ b/src/Content/Widget/TagCloud.php @@ -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 * diff --git a/src/Core/Addon.php b/src/Core/Addon.php index 252acd31f..799a447d2 100644 --- a/src/Core/Addon.php +++ b/src/Core/Addon.php @@ -83,7 +83,7 @@ class Addon /** - * @brief Synchronize addons: + * Synchronize addons: * * system.addon contains a comma-separated list of names * of addons which are used on this system. @@ -130,7 +130,7 @@ class Addon } /** - * @brief uninstalls an addon. + * uninstalls an addon. * * @param string $addon name of the addon * @return void @@ -157,7 +157,7 @@ class Addon } /** - * @brief installs an addon. + * installs an addon. * * @param string $addon name of the addon * @return bool @@ -249,7 +249,7 @@ class Addon } /** - * @brief Parse addon comment in search of addon infos. + * Parse addon comment in search of addon infos. * * like * \code diff --git a/src/Core/Config.php b/src/Core/Config.php index 6864cb78d..83889f115 100644 --- a/src/Core/Config.php +++ b/src/Core/Config.php @@ -4,14 +4,14 @@ * * @file include/Core/Config.php * - * @brief Contains the class with methods for system configuration + * Contains the class with methods for system configuration */ namespace Friendica\Core; use Friendica\DI; /** - * @brief Arbitrary system configuration storage + * Arbitrary system configuration storage * * Note: * If we ever would decide to return exactly the variable type as entered, @@ -20,7 +20,7 @@ use Friendica\DI; class Config { /** - * @brief Loads all configuration values of family into a cached storage. + * Loads all configuration values of family into a cached storage. * * @param string $cat The category of the configuration value * @@ -32,8 +32,7 @@ class Config } /** - * @brief Get a particular user's config variable given the category name - * ($family) and a key. + * Get a particular user's config variable given the category name ($family) and a key. * * @param string $cat The category of the configuration value * @param string $key The configuration key to query @@ -48,8 +47,6 @@ class Config } /** - * @brief Sets a configuration value for system config - * * Stores a config value ($value) in the category ($cat) under the key ($key) * * Note: Please do not store booleans - convert to 0/1 integer values! @@ -66,7 +63,7 @@ class Config } /** - * @brief Deletes the given key from the system configuration. + * Deletes the given key from the system configuration. * * @param string $cat The category of the configuration value * @param string $key The configuration key to delete diff --git a/src/Core/Config/IConfiguration.php b/src/Core/Config/IConfiguration.php index 4bd44f099..3afe86635 100644 --- a/src/Core/Config/IConfiguration.php +++ b/src/Core/Config/IConfiguration.php @@ -9,7 +9,7 @@ interface IConfiguration { /** - * @brief Loads all configuration values of family into a cached storage. + * Loads all configuration values of family into a cached storage. * * All configuration values of the system are stored in the cache ( @see ConfigCache ) * @@ -20,7 +20,7 @@ interface IConfiguration function load(string $cat = 'config'); /** - * @brief Get a particular user's config variable given the category name + * Get a particular user's config variable given the category name * ($cat) and a $key. * * Get a particular config value from the given category ($cat) @@ -37,7 +37,7 @@ interface IConfiguration function get(string $cat, string $key, $default_value = null, bool $refresh = false); /** - * @brief Sets a configuration value for system config + * Sets a configuration value for system config * * Stores a config value ($value) in the category ($cat) under the key ($key) * @@ -52,7 +52,7 @@ interface IConfiguration function set(string $cat, string $key, $value); /** - * @brief Deletes the given key from the system configuration. + * Deletes the given key from the system configuration. * * Removes the configured value from the stored cache in $this->configCache * (@see ConfigCache) and removes it from the database (@see IConfigAdapter). diff --git a/src/Core/Hook.php b/src/Core/Hook.php index b8ad0fb8b..f282d02c7 100644 --- a/src/Core/Hook.php +++ b/src/Core/Hook.php @@ -45,7 +45,7 @@ class Hook } /** - * @brief Adds a new hook to the hooks array. + * Adds a new hook to the hooks array. * * This function is meant to be called by modules on each page load as it works after loadHooks has been called. * @@ -62,7 +62,7 @@ class Hook } /** - * @brief Registers a hook. + * Registers a hook. * * This function is meant to be called once when an addon is enabled for example as it doesn't add to the current hooks. * @@ -127,7 +127,7 @@ class Hook } /** - * @brief Forks a hook. + * Forks a hook. * * Use this function when you want to fork a hook via the worker. * @@ -162,7 +162,7 @@ class Hook } /** - * @brief Calls a hook. + * Calls a hook. * * Use this function when you want to be able to allow a hook to manipulate * the provided data. @@ -181,7 +181,7 @@ class Hook } /** - * @brief Calls a single hook. + * Calls a single hook. * * @param App $a * @param string $name of the hook to call diff --git a/src/Core/L10n.php b/src/Core/L10n.php index 82f02b83d..2c8a9eef9 100644 --- a/src/Core/L10n.php +++ b/src/Core/L10n.php @@ -36,7 +36,7 @@ class L10n } /** - * @brief Return the localized version of the provided string with optional string interpolation + * Return the localized version of the provided string with optional string interpolation * * This function takes a english string as parameter, and if a localized version * exists for the current language, substitutes it before performing an eventual @@ -58,7 +58,7 @@ class L10n } /** - * @brief Return the localized version of a singular/plural string with optional string interpolation + * Return the localized version of a singular/plural string with optional string interpolation * * This function takes two english strings as parameters, singular and plural, as * well as a count. If a localized version exists for the current language, they @@ -83,7 +83,7 @@ class L10n } /** - * @brief Return installed languages codes as associative array + * Return installed languages codes as associative array * * Scans the view/lang directory for the existence of "strings.php" files, and * returns an alphabetical list of their folder names (@-char language codes). @@ -99,7 +99,7 @@ class L10n } /** - * @brief Translate days and months names. + * Translate days and months names. * * @param string $s String with day or month name. * @@ -111,7 +111,7 @@ class L10n } /** - * @brief Translate short days and months names. + * Translate short days and months names. * * @param string $s String with short day or month name. * diff --git a/src/Core/L10n/L10n.php b/src/Core/L10n/L10n.php index 8b2238c7a..ea19d16d0 100644 --- a/src/Core/L10n/L10n.php +++ b/src/Core/L10n/L10n.php @@ -132,7 +132,7 @@ class L10n } /** - * @brief Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header + * Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header * * @param string $sysLang The default fallback language * @param array $server The $_SERVER array @@ -210,7 +210,7 @@ class L10n } /** - * @brief Return the localized version of the provided string with optional string interpolation + * Return the localized version of the provided string with optional string interpolation * * This function takes a english string as parameter, and if a localized version * exists for the current language, substitutes it before performing an eventual @@ -245,7 +245,7 @@ class L10n } /** - * @brief Return the localized version of a singular/plural string with optional string interpolation + * Return the localized version of a singular/plural string with optional string interpolation * * This function takes two english strings as parameters, singular and plural, as * well as a count. If a localized version exists for the current language, they diff --git a/src/Core/Logger.php b/src/Core/Logger.php index 0ce2a6e67..3d6594b18 100644 --- a/src/Core/Logger.php +++ b/src/Core/Logger.php @@ -10,7 +10,7 @@ use Psr\Log\LoggerInterface; use Psr\Log\LogLevel; /** - * @brief Logger functions + * Logger functions */ class Logger { @@ -231,8 +231,8 @@ class Logger self::getWorker()->debug($message, $context); } - /** - * @brief Logs the given message at the given log level + /** + * Logs the given message at the given log level * * @param string $msg * @param string $level @@ -246,7 +246,8 @@ class Logger } /** - * @brief An alternative logger for development. + * An alternative logger for development. + * * Works largely as log() but allows developers * to isolate particular elements they are targetting * personally without background noise diff --git a/src/Core/Process.php b/src/Core/Process.php index a7f8de286..60ad14aa6 100644 --- a/src/Core/Process.php +++ b/src/Core/Process.php @@ -46,7 +46,7 @@ final class Process } /** - * @brief Checks if the maximum number of database processes is reached + * Checks if the maximum number of database processes is reached * * @return bool Is the limit reached? */ @@ -86,7 +86,7 @@ final class Process } /** - * @brief Checks if the minimal memory is reached + * Checks if the minimal memory is reached * * @return bool Is the memory limit reached? */ @@ -130,7 +130,7 @@ final class Process } /** - * @brief Checks if the maximum load is reached + * Checks if the maximum load is reached * * @return bool Is the load reached? */ diff --git a/src/Core/Renderer.php b/src/Core/Renderer.php index 32247310c..eca22bdcd 100644 --- a/src/Core/Renderer.php +++ b/src/Core/Renderer.php @@ -11,22 +11,22 @@ use Friendica\Render\FriendicaSmarty; use Friendica\Render\ITemplateEngine; /** - * @brief This class handles Renderer related functions. + * This class handles Renderer related functions. */ class Renderer { /** - * @brief An array of registered template engines ('name'=>'class name') + * An array of registered template engines ('name'=>'class name') */ public static $template_engines = []; /** - * @brief An array of instanced template engines ('name'=>'instance') + * An array of instanced template engines ('name'=>'instance') */ public static $template_engine_instance = []; /** - * @brief An array for all theme-controllable parameters + * An array for all theme-controllable parameters * * Mostly unimplemented yet. Only options 'template_engine' and * beyond are used. @@ -50,7 +50,7 @@ class Renderer ]; /** - * @brief This is our template processor + * This is our template processor * * @param string|FriendicaSmarty $s The string requiring macro substitution or an instance of FriendicaSmarty * @param array $vars Key value pairs (search => replace) @@ -80,7 +80,7 @@ class Renderer } /** - * @brief Load a given template $s + * Load a given template $s * * @param string $s Template to load. * @param string $root Optional. @@ -107,7 +107,7 @@ class Renderer } /** - * @brief Register template engine class + * Register template engine class * * @param string $class */ @@ -126,7 +126,7 @@ class Renderer } /** - * @brief Return template engine instance. + * Return template engine instance. * * If $name is not defined, return engine defined by theme, * or default @@ -153,7 +153,7 @@ class Renderer } /** - * @brief Returns the active template engine. + * Returns the active template engine. * * @return string the active template engine */ diff --git a/src/Core/Search.php b/src/Core/Search.php index d187e9395..7c00e6224 100644 --- a/src/Core/Search.php +++ b/src/Core/Search.php @@ -245,7 +245,6 @@ class Search /** * Searching for global contacts for autocompletion * - * @brief Searching for global contacts for autocompletion * @param string $search Name or part of a name or nick * @param string $mode Search mode (e.g. "community") * @param int $page Page number (starts at 1) diff --git a/src/Core/Session/Handler/Cache.php b/src/Core/Session/Handler/Cache.php index ecd266adb..094f360d4 100644 --- a/src/Core/Session/Handler/Cache.php +++ b/src/Core/Session/Handler/Cache.php @@ -51,7 +51,7 @@ final class Cache implements SessionHandlerInterface } /** - * @brief Standard PHP session write callback + * Standard PHP session write callback * * This callback updates the stored session data and/or the expiration depending * on the case. Uses the Session::expire for existing session, 5 minutes diff --git a/src/Core/Session/Handler/Database.php b/src/Core/Session/Handler/Database.php index e8151dddc..e633c500e 100644 --- a/src/Core/Session/Handler/Database.php +++ b/src/Core/Session/Handler/Database.php @@ -58,7 +58,7 @@ final class Database implements SessionHandlerInterface } /** - * @brief Standard PHP session write callback + * Standard PHP session write callback * * This callback updates the DB-stored session data and/or the expiration depending * on the case. Uses the Session::expire global for existing session, 5 minutes diff --git a/src/Core/StorageManager.php b/src/Core/StorageManager.php index 8fd0d1a93..397fc624f 100644 --- a/src/Core/StorageManager.php +++ b/src/Core/StorageManager.php @@ -11,7 +11,7 @@ use Psr\Log\LoggerInterface; /** - * @brief Manage storage backends + * Manage storage backends * * Core code uses this class to get and set current storage backend class. * Addons use this class to register and unregister additional backends. @@ -67,7 +67,7 @@ class StorageManager } /** - * @brief Return current storage backend class + * Return current storage backend class * * @return Storage\IStorage|null */ @@ -77,7 +77,7 @@ class StorageManager } /** - * @brief Return storage backend class by registered name + * Return storage backend class by registered name * * @param string|null $name Backend name * @param boolean $onlyUserBackend True, if just user specific instances should be returrned (e.g. not SystemResource) @@ -163,7 +163,7 @@ class StorageManager } /** - * @brief Set current storage backend class + * Set current storage backend class * * @param string $name Backend class name * @@ -184,7 +184,7 @@ class StorageManager } /** - * @brief Get registered backends + * Get registered backends * * @return array */ @@ -222,7 +222,7 @@ class StorageManager } /** - * @brief Unregister a storage backend class + * Unregister a storage backend class * * @param string $class Backend class name * @@ -247,7 +247,7 @@ class StorageManager } /** - * @brief Move up to 5000 resources to storage $dest + * Move up to 5000 resources to storage $dest * * Copy existing data to destination storage and delete from source. * This method cannot move to legacy in-table `data` field. diff --git a/src/Core/System.php b/src/Core/System.php index 5b882efac..a2b88a631 100644 --- a/src/Core/System.php +++ b/src/Core/System.php @@ -11,17 +11,17 @@ use Friendica\Util\XML; /** * @file include/Core/System.php * - * @brief Contains the class with system relevant stuff + * Contains the class with system relevant stuff */ /** - * @brief System methods + * System methods */ class System { /** - * @brief Returns a string with a callstack. Can be used for logging. + * Returns a string with a callstack. Can be used for logging. * @param integer $depth optional, default 4 * @return string */ @@ -93,7 +93,7 @@ class System } /** - * @brief Send HTTP status header and exit. + * Send HTTP status header and exit. * * @param integer $val HTTP status result value * @param string $message Error message. Optional. @@ -117,7 +117,7 @@ class System } /** - * @brief Encodes content to json. + * Encodes content to json. * * This function encodes an array to json format * and adds an application/json HTTP header to the output. @@ -227,7 +227,7 @@ class System } /** - * @brief Returns the system user that is executing the script + * Returns the system user that is executing the script * * This mostly returns something like "www-data". * @@ -244,7 +244,7 @@ class System } /** - * @brief Checks if a given directory is usable for the system + * Checks if a given directory is usable for the system * * @param $directory * @param bool $check_writable diff --git a/src/Core/Theme.php b/src/Core/Theme.php index 6f0d9d436..bf3e3418a 100644 --- a/src/Core/Theme.php +++ b/src/Core/Theme.php @@ -40,7 +40,7 @@ class Theme } /** - * @brief Parse theme comment in search of theme infos. + * Parse theme comment in search of theme infos. * * like * \code @@ -110,7 +110,7 @@ class Theme } /** - * @brief Returns the theme's screenshot. + * Returns the theme's screenshot. * * The screenshot is expected as view/theme/$theme/screenshot.[png|jpg]. * @@ -182,7 +182,7 @@ class Theme } /** - * @brief Get the full path to relevant theme files by filename + * Get the full path to relevant theme files by filename * * This function searches in order in the current theme directory, in the current theme parent directory, and lastly * in the base view/ folder. @@ -215,7 +215,7 @@ class Theme } /** - * @brief Return relative path to theme stylesheet file + * Return relative path to theme stylesheet file * * Provide a sane default if nothing is chosen or the specified theme does not exist. * diff --git a/src/Core/Update.php b/src/Core/Update.php index 0de7db9cb..3fe19d0dd 100644 --- a/src/Core/Update.php +++ b/src/Core/Update.php @@ -14,7 +14,7 @@ class Update const FAILED = 1; /** - * @brief Function to check if the Database structure needs an update. + * Function to check if the Database structure needs an update. * * @param string $basePath The base path of this application * @param boolean $via_worker Is the check run via the worker? diff --git a/src/Core/UserImport.php b/src/Core/UserImport.php index ae9bd944c..a62ce4358 100644 --- a/src/Core/UserImport.php +++ b/src/Core/UserImport.php @@ -14,7 +14,7 @@ use Friendica\Util\Strings; use Friendica\Worker\Delivery; /** - * @brief UserImport class + * UserImport class */ class UserImport { @@ -84,7 +84,7 @@ class UserImport } /** - * @brief Import account file exported from mod/uexport + * Import account file exported from mod/uexport * * @param array $file array from $_FILES * @throws \Friendica\Network\HTTPException\InternalServerErrorException diff --git a/src/Core/Worker.php b/src/Core/Worker.php index 086934fb8..2e6e03e9b 100644 --- a/src/Core/Worker.php +++ b/src/Core/Worker.php @@ -14,11 +14,11 @@ use Friendica\Util\Network; /** * @file src/Core/Worker.php * - * @brief Contains the class for the worker background job processing + * Contains the class for the worker background job processing */ /** - * @brief Worker methods + * Worker methods */ class Worker { @@ -40,7 +40,7 @@ class Worker private static $state; /** - * @brief Processes the tasks that are in the workerqueue table + * Processes the tasks that are in the workerqueue table * * @param boolean $run_cron Should the cron processes be executed? * @return void @@ -163,7 +163,7 @@ class Worker } /** - * @brief Check if non executed tasks do exist in the worker queue + * Check if non executed tasks do exist in the worker queue * * @return boolean Returns "true" if tasks are existing * @throws \Exception @@ -177,7 +177,7 @@ class Worker } /** - * @brief Returns the number of deferred entries in the worker queue + * Returns the number of deferred entries in the worker queue * * @return integer Number of deferred entries in the worker queue * @throws \Exception @@ -192,7 +192,7 @@ class Worker } /** - * @brief Returns the number of non executed entries in the worker queue + * Returns the number of non executed entries in the worker queue * * @return integer Number of non executed entries in the worker queue * @throws \Exception @@ -207,7 +207,7 @@ class Worker } /** - * @brief Returns the highest priority in the worker queue that isn't executed + * Returns the highest priority in the worker queue that isn't executed * * @return integer Number of active worker processes * @throws \Exception @@ -226,7 +226,7 @@ class Worker } /** - * @brief Returns if a process with the given priority is running + * Returns if a process with the given priority is running * * @param integer $priority The priority that should be checked * @@ -240,7 +240,7 @@ class Worker } /** - * @brief Execute a worker entry + * Execute a worker entry * * @param array $queue Workerqueue entry * @@ -359,7 +359,7 @@ class Worker } /** - * @brief Execute a function from the queue + * Execute a function from the queue * * @param array $queue Workerqueue entry * @param string $funcname name of the function @@ -450,7 +450,7 @@ class Worker } /** - * @brief Checks if the number of database connections has reached a critical limit. + * Checks if the number of database connections has reached a critical limit. * * @return bool Are more than 3/4 of the maximum connections used? * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -533,7 +533,7 @@ class Worker } /** - * @brief fix the queue entry if the worker process died + * fix the queue entry if the worker process died * @return void * @throws \Exception */ @@ -605,7 +605,7 @@ class Worker } /** - * @brief Checks if the number of active workers exceeds the given limits + * Checks if the number of active workers exceeds the given limits * * @return bool Are there too much workers running? * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -735,7 +735,7 @@ class Worker } /** - * @brief Returns the number of active worker processes + * Returns the number of active worker processes * * @return integer Number of active worker processes * @throws \Exception @@ -749,7 +749,7 @@ class Worker } /** - * @brief Returns waiting jobs for the current process id + * Returns waiting jobs for the current process id * * @return array waiting workerqueue jobs * @throws \Exception @@ -768,7 +768,7 @@ class Worker } /** - * @brief Returns the next jobs that should be executed + * Returns the next jobs that should be executed * * @return array array with next jobs * @throws \Exception @@ -803,7 +803,7 @@ class Worker } /** - * @brief Returns the priority of the next workerqueue job + * Returns the priority of the next workerqueue job * * @return string priority * @throws \Exception @@ -876,7 +876,7 @@ class Worker } /** - * @brief Find and claim the next worker process for us + * Find and claim the next worker process for us * * @return boolean Have we found something? * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -919,7 +919,7 @@ class Worker } /** - * @brief Returns the next worker process + * Returns the next worker process * * @return string SQL statement * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -952,7 +952,7 @@ class Worker } /** - * @brief Removes a workerqueue entry from the current process + * Removes a workerqueue entry from the current process * @return void * @throws \Exception */ @@ -967,7 +967,7 @@ class Worker } /** - * @brief Call the front end worker + * Call the front end worker * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ @@ -982,7 +982,7 @@ class Worker } /** - * @brief Call the front end worker if there aren't any active + * Call the front end worker if there aren't any active * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ @@ -1033,7 +1033,7 @@ class Worker } /** - * @brief Removes long running worker processes + * Removes long running worker processes * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ @@ -1051,7 +1051,7 @@ class Worker } /** - * @brief Runs the cron processes + * Runs the cron processes * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ @@ -1070,7 +1070,7 @@ class Worker } /** - * @brief Spawns a new worker + * Spawns a new worker * @param bool $do_cron * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -1092,7 +1092,7 @@ class Worker } /** - * @brief Adds tasks to the worker queue + * Adds tasks to the worker queue * * @param (integer|array) priority or parameter array, strings are deprecated and are ignored * @@ -1272,8 +1272,6 @@ class Worker /** * Log active processes into the "process" table - * - * @brief Log active processes into the "process" table */ public static function startProcess() { @@ -1289,7 +1287,6 @@ class Worker /** * Remove the active process from the "process" table * - * @brief Remove the active process from the "process" table * @return bool * @throws \Exception */ @@ -1301,7 +1298,6 @@ class Worker /** * Set the flag if some job is waiting * - * @brief Set the flag if some job is waiting * @param boolean $jobs Is there a waiting job? * @throws \Exception */ @@ -1316,7 +1312,6 @@ class Worker /** * Checks if some worker job waits to be executed * - * @brief Checks if some worker job waits to be executed * @return bool * @throws \Exception */ diff --git a/src/Database/DBA.php b/src/Database/DBA.php index 5ebcb60e3..f4d4bb11d 100644 --- a/src/Database/DBA.php +++ b/src/Database/DBA.php @@ -207,7 +207,6 @@ class DBA * * Please use DBA::selectFirst or DBA::exists whenever this is possible. * - * @brief Fetches the first row * @param string $sql SQL statement * @return array first row of query * @throws \Exception @@ -360,7 +359,9 @@ class DBA } /** - * Updates rows in the database. When $old_fields is set to an array, + * Updates rows in the database. + * + * When $old_fields is set to an array, * the system will only do an update if the fields in that array changed. * * Attention: @@ -378,7 +379,6 @@ class DBA * Only set $old_fields to a boolean value when you are sure that you will update a single row. * When you set $old_fields to "true" then $fields must contain all relevant fields! * - * @brief Updates rows * @param string|array $table Table name or array [schema => table] * @param array $fields contains the fields that are updated * @param array $condition condition array with the key values diff --git a/src/Database/DBStructure.php b/src/Database/DBStructure.php index 3b3f55ba5..3aab8856f 100644 --- a/src/Database/DBStructure.php +++ b/src/Database/DBStructure.php @@ -15,8 +15,6 @@ use Friendica\Util\DateTimeFormat; require_once __DIR__ . '/../../include/dba.php'; /** - * @brief This class contain functions for the database management - * * This class contains functions that doesn't need to know if pdo, mysqli or whatever is used. */ class DBStructure @@ -63,7 +61,7 @@ class DBStructure } /** - * @brief Print out database error messages + * Print out database error messages * * @param string $message Message to be added to the error message * diff --git a/src/Database/Database.php b/src/Database/Database.php index bd295fc9e..ca525cd37 100644 --- a/src/Database/Database.php +++ b/src/Database/Database.php @@ -226,7 +226,7 @@ class Database } /** - * @brief Returns the MySQL server version string + * Returns the MySQL server version string * * This function discriminate between the deprecated mysql API and the current * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1 @@ -249,7 +249,7 @@ class Database } /** - * @brief Returns the selected database name + * Returns the selected database name * * @return string * @throws \Exception @@ -262,7 +262,7 @@ class Database } /** - * @brief Analyze a database query and log this if some conditions are met. + * Analyze a database query and log this if some conditions are met. * * @param string $query The database query that will be analyzed * @@ -378,8 +378,8 @@ class Database } /** - * @brief Replaces ANY_VALUE() function by MIN() function, - * if the database server does not support ANY_VALUE(). + * Replaces ANY_VALUE() function by MIN() function, + * if the database server does not support ANY_VALUE(). * * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5). * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html @@ -400,7 +400,7 @@ class Database } /** - * @brief Replaces the ? placeholders with the parameters in the $args array + * Replaces the ? placeholders with the parameters in the $args array * * @param string $sql SQL query * @param array $args The parameters that are to replace the ? placeholders @@ -427,7 +427,7 @@ class Database } /** - * @brief Executes a prepared statement that returns data + * Executes a prepared statement that returns data * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid); * * Please only use it with complicated queries. @@ -667,7 +667,7 @@ class Database } /** - * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data + * Executes a prepared statement like UPDATE or INSERT that doesn't return data * * Please use DBA::delete, DBA::insert, DBA::update, ... instead * @@ -733,7 +733,7 @@ class Database } /** - * @brief Check if data exists + * Check if data exists * * @param string|array $table Table name or array [schema => table] * @param array $condition array of fields for condition @@ -777,7 +777,7 @@ class Database * * Please use DBA::selectFirst or DBA::exists whenever this is possible. * - * @brief Fetches the first row + * Fetches the first row * * @param string $sql SQL statement * @@ -802,7 +802,7 @@ class Database } /** - * @brief Returns the number of affected rows of the last statement + * Returns the number of affected rows of the last statement * * @return int Number of rows */ @@ -812,7 +812,7 @@ class Database } /** - * @brief Returns the number of columns of a statement + * Returns the number of columns of a statement * * @param object Statement object * @@ -833,7 +833,7 @@ class Database } /** - * @brief Returns the number of rows of a statement + * Returns the number of rows of a statement * * @param PDOStatement|mysqli_result|mysqli_stmt Statement object * @@ -854,7 +854,7 @@ class Database } /** - * @brief Fetch a single row + * Fetch a single row * * @param mixed $stmt statement object * @@ -914,7 +914,7 @@ class Database } /** - * @brief Insert a row into a table + * Insert a row into a table * * @param string|array $table Table name or array [schema => table] * @param array $param parameter array @@ -951,7 +951,7 @@ class Database } /** - * @brief Fetch the id of the last insert command + * Fetch the id of the last insert command * * @return integer Last inserted id */ @@ -969,7 +969,7 @@ class Database } /** - * @brief Locks a table for exclusive write access + * Locks a table for exclusive write access * * This function can be extended in the future to accept a table array as well. * @@ -1007,7 +1007,7 @@ class Database } /** - * @brief Unlocks all locked tables + * Unlocks all locked tables * * @return boolean was the unlock successful? * @throws \Exception @@ -1035,7 +1035,7 @@ class Database } /** - * @brief Starts a transaction + * Starts a transaction * * @return boolean Was the command executed successfully? */ @@ -1081,7 +1081,7 @@ class Database } /** - * @brief Does a commit + * Does a commit * * @return boolean Was the command executed successfully? */ @@ -1095,7 +1095,7 @@ class Database } /** - * @brief Does a rollback + * Does a rollback * * @return boolean Was the command executed successfully? */ @@ -1121,7 +1121,7 @@ class Database } /** - * @brief Build the array with the table relations + * Build the array with the table relations * * The array is build from the database definitions in DBStructure.php * @@ -1143,7 +1143,7 @@ class Database } /** - * @brief Delete a row from a table + * Delete a row from a table * * Note: this methods does NOT accept schema => table arrays because of the complex relation stuff. * @@ -1292,7 +1292,7 @@ class Database } /** - * @brief Updates rows + * Updates rows * * Updates rows in the database. When $old_fields is set to an array, * the system will only do an update if the fields in that array changed. @@ -1374,8 +1374,6 @@ class Database /** * Retrieve a single record from a table and returns it in an associative array * - * @brief Retrieve a single record from a table - * * @param string|array $table * @param array $fields * @param array $condition @@ -1400,7 +1398,7 @@ class Database } /** - * @brief Select rows from a table and fills an array with the data + * Select rows from a table and fills an array with the data * * @param string|array $table Table name or array [schema => table] * @param array $fields Array of selected fields, empty for all @@ -1417,7 +1415,7 @@ class Database } /** - * @brief Select rows from a table + * Select rows from a table * * @param string|array $table Table name or array [schema => table] * @param array $fields Array of selected fields, empty for all @@ -1465,7 +1463,7 @@ class Database } /** - * @brief Counts the rows from a table satisfying the provided condition + * Counts the rows from a table satisfying the provided condition * * @param string|array $table Table name or array [schema => table] * @param array $condition Array of fields for condition @@ -1509,7 +1507,7 @@ class Database } /** - * @brief Fills an array with data from a query + * Fills an array with data from a query * * @param object $stmt statement object * @param bool $do_close @@ -1535,7 +1533,7 @@ class Database } /** - * @brief Returns the error number of the last query + * Returns the error number of the last query * * @return string Error number (0 if no error) */ @@ -1545,7 +1543,7 @@ class Database } /** - * @brief Returns the error message of the last query + * Returns the error message of the last query * * @return string Error message ('' if no error) */ @@ -1555,7 +1553,7 @@ class Database } /** - * @brief Closes the current statement + * Closes the current statement * * @param object $stmt statement object * @@ -1596,7 +1594,7 @@ class Database } /** - * @brief Return a list of database processes + * Return a list of database processes * * @return array * 'list' => List of processes, separated in their different states @@ -1652,7 +1650,7 @@ class Database } /** - * @brief Callback function for "esc_array" + * Callback function for "esc_array" * * @param mixed $value Array value * @param string $key Array key @@ -1681,7 +1679,7 @@ class Database } /** - * @brief Escapes a whole array + * Escapes a whole array * * @param mixed $arr Array with values to be escaped * @param boolean $add_quotation add quotation marks for string values diff --git a/src/Database/PostUpdate.php b/src/Database/PostUpdate.php index f0050e0ef..50e7dbcc9 100644 --- a/src/Database/PostUpdate.php +++ b/src/Database/PostUpdate.php @@ -19,7 +19,7 @@ use Friendica\Model\PermissionSet; class PostUpdate { /** - * @brief Calls the post update functions + * Calls the post update functions */ public static function update() { @@ -49,7 +49,7 @@ class PostUpdate } /** - * @brief Updates the "global" field in the item table + * Updates the "global" field in the item table * * @return bool "true" when the job is done * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -118,7 +118,7 @@ class PostUpdate } /** - * @brief update the "last-item" field in the "self" contact + * update the "last-item" field in the "self" contact * * This field avoids cost intensive calls in the admin panel and in "nodeinfo" * @@ -153,7 +153,7 @@ class PostUpdate } /** - * @brief update the item related tables + * update the item related tables * * @return bool "true" when the job is done * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -305,7 +305,7 @@ class PostUpdate } /** - * @brief update item-uri data. Prerequisite for the next item structure update. + * update item-uri data. Prerequisite for the next item structure update. * * @return bool "true" when the job is done * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -459,7 +459,7 @@ class PostUpdate } /** - * @brief update user-item data with notifications + * update user-item data with notifications * * @return bool "true" when the job is done * @throws \Friendica\Network\HTTPException\InternalServerErrorException diff --git a/src/Factory/LockFactory.php b/src/Factory/LockFactory.php index edfc6f6bd..8ea0642b1 100644 --- a/src/Factory/LockFactory.php +++ b/src/Factory/LockFactory.php @@ -87,7 +87,7 @@ class LockFactory } /** - * @brief This method tries to find the best - local - locking method for Friendica + * This method tries to find the best - local - locking method for Friendica * * The following sequence will be tried: * 1. Semaphore Locking diff --git a/src/Model/Attach.php b/src/Model/Attach.php index fc0ebb8e2..b5dd64e0c 100644 --- a/src/Model/Attach.php +++ b/src/Model/Attach.php @@ -2,7 +2,7 @@ /** * @file src/Model/Attach.php - * @brief This file contains the Attach class for database interface + * This file contains the Attach class for database interface */ namespace Friendica\Model; @@ -22,7 +22,7 @@ class Attach { /** - * @brief Return a list of fields that are associated with the attach table + * Return a list of fields that are associated with the attach table * * @return array field list * @throws \Exception @@ -36,7 +36,7 @@ class Attach } /** - * @brief Select rows from the attach table and return them as array + * Select rows from the attach table and return them as array * * @param array $fields Array of selected fields, empty for all * @param array $conditions Array of fields for conditions @@ -57,7 +57,7 @@ class Attach } /** - * @brief Retrieve a single record from the attach table + * Retrieve a single record from the attach table * * @param array $fields Array of selected fields, empty for all * @param array $conditions Array of fields for conditions @@ -78,7 +78,7 @@ class Attach } /** - * @brief Check if attachment with given conditions exists + * Check if attachment with given conditions exists * * @param array $conditions Array of extra conditions * @@ -91,7 +91,7 @@ class Attach } /** - * @brief Retrive a single record given the ID + * Retrive a single record given the ID * * @param int $id Row id of the record * @@ -106,7 +106,7 @@ class Attach } /** - * @brief Retrive a single record given the ID + * Retrive a single record given the ID * * @param int $id Row id of the record * @@ -135,7 +135,7 @@ class Attach } /** - * @brief Get file data for given row id. null if row id does not exist + * Get file data for given row id. null if row id does not exist * * @param array $item Attachment data. Needs at least 'id', 'backend-class', 'backend-ref' * @@ -159,7 +159,7 @@ class Attach } /** - * @brief Store new file metadata in db and binary in default backend + * Store new file metadata in db and binary in default backend * * @param string $data Binary data * @param integer $uid User ID @@ -215,7 +215,7 @@ class Attach } /** - * @brief Store new file metadata in db and binary in default backend from existing file + * Store new file metadata in db and binary in default backend from existing file * * @param $src * @param $uid @@ -240,7 +240,7 @@ class Attach /** - * @brief Update an attached file + * Update an attached file * * @param array $fields Contains the fields that are updated * @param array $conditions Condition array with the key values @@ -275,7 +275,7 @@ class Attach /** - * @brief Delete info from table and data from storage + * Delete info from table and data from storage * * @param array $conditions Field condition(s) * @param array $options Options array, Optional diff --git a/src/Model/Contact.php b/src/Model/Contact.php index 550f89f31..ab2bfa87a 100644 --- a/src/Model/Contact.php +++ b/src/Model/Contact.php @@ -29,7 +29,7 @@ use Friendica\Util\Network; use Friendica\Util\Strings; /** - * @brief functions for interacting with a contact + * functions for interacting with a contact */ class Contact { @@ -174,7 +174,7 @@ class Contact } /** - * @brief Tests if the given contact is a follower + * Tests if the given contact is a follower * * @param int $cid Either public contact id or user's contact id * @param int $uid User ID @@ -199,7 +199,7 @@ class Contact } /** - * @brief Tests if the given contact url is a follower + * Tests if the given contact url is a follower * * @param string $url Contact URL * @param int $uid User ID @@ -220,7 +220,7 @@ class Contact } /** - * @brief Tests if the given user follow the given contact + * Tests if the given user follow the given contact * * @param int $cid Either public contact id or user's contact id * @param int $uid User ID @@ -245,7 +245,7 @@ class Contact } /** - * @brief Tests if the given user follow the given contact url + * Tests if the given user follow the given contact url * * @param string $url Contact URL * @param int $uid User ID @@ -266,7 +266,7 @@ class Contact } /** - * @brief Get the basepath for a given contact link + * Get the basepath for a given contact link * * @param string $url The contact link * @param boolean $dont_update Don't update the contact @@ -355,7 +355,7 @@ class Contact } /** - * @brief Returns the contact id for the user and the public contact id for a given contact id + * Returns the contact id for the user and the public contact id for a given contact id * * @param int $cid Either public contact id or user's contact id * @param int $uid User ID @@ -417,7 +417,7 @@ class Contact } /** - * @brief Block contact id for user id + * Block contact id for user id * * @param int $cid Either public contact id or user's contact id * @param int $uid User ID @@ -439,7 +439,7 @@ class Contact } /** - * @brief Returns "block" state for contact id and user id + * Returns "block" state for contact id and user id * * @param int $cid Either public contact id or user's contact id * @param int $uid User ID @@ -480,7 +480,7 @@ class Contact } /** - * @brief Ignore contact id for user id + * Ignore contact id for user id * * @param int $cid Either public contact id or user's contact id * @param int $uid User ID @@ -502,7 +502,7 @@ class Contact } /** - * @brief Returns "ignore" state for contact id and user id + * Returns "ignore" state for contact id and user id * * @param int $cid Either public contact id or user's contact id * @param int $uid User ID @@ -543,7 +543,7 @@ class Contact } /** - * @brief Set "collapsed" for contact id and user id + * Set "collapsed" for contact id and user id * * @param int $cid Either public contact id or user's contact id * @param int $uid User ID @@ -561,7 +561,7 @@ class Contact } /** - * @brief Returns "collapsed" state for contact id and user id + * Returns "collapsed" state for contact id and user id * * @param int $cid Either public contact id or user's contact id * @param int $uid User ID @@ -590,7 +590,7 @@ class Contact } /** - * @brief Returns a list of contacts belonging in a group + * Returns a list of contacts belonging in a group * * @param int $gid * @return array @@ -625,7 +625,7 @@ class Contact } /** - * @brief Returns the count of OStatus contacts in a group + * Returns the count of OStatus contacts in a group * * @param int $gid * @return int @@ -807,7 +807,7 @@ class Contact } /** - * @brief Marks a contact for removal + * Marks a contact for removal * * @param int $id contact id * @return null @@ -829,7 +829,7 @@ class Contact } /** - * @brief Sends an unfriend message. Does not remove the contact + * Sends an unfriend message. Does not remove the contact * * @param array $user User unfriending * @param array $contact Contact unfriended @@ -878,7 +878,7 @@ class Contact } /** - * @brief Marks a contact for archival after a communication issue delay + * Marks a contact for archival after a communication issue delay * * Contact has refused to recognise us as a friend. We will start a countdown. * If they still don't recognise us in 32 days, the relationship is over, @@ -936,7 +936,7 @@ class Contact } /** - * @brief Cancels the archival countdown + * Cancels the archival countdown * * @see Contact::markForArchival() * @@ -979,7 +979,7 @@ class Contact } /** - * @brief Get contact data for a given profile link + * Get contact data for a given profile link * * The function looks at several places (contact table and gcontact table) for the contact * It caches its result for the same script execution to prevent duplicate calls @@ -1126,7 +1126,7 @@ class Contact } /** - * @brief Get contact data for a given address + * Get contact data for a given address * * The function looks at several places (contact table and gcontact table) for the contact * @@ -1184,7 +1184,7 @@ class Contact } /** - * @brief Returns the data array for the photo menu of a given contact + * Returns the data array for the photo menu of a given contact * * @param array $contact contact * @param int $uid optional, default 0 @@ -1313,7 +1313,7 @@ class Contact } /** - * @brief Returns ungrouped contact count or list for user + * Returns ungrouped contact count or list for user * * Returns either the total number of ungrouped contacts for the given user * id or a paginated list of ungrouped contacts. @@ -1424,7 +1424,7 @@ class Contact } /** - * @brief Fetch the contact id for a given URL and user + * Fetch the contact id for a given URL and user * * First lookup in the contact table to find a record matching either `url`, `nurl`, * `addr` or `alias`. @@ -1662,7 +1662,7 @@ class Contact } /** - * @brief Checks if the contact is archived + * Checks if the contact is archived * * @param int $cid contact id * @@ -1706,7 +1706,7 @@ class Contact } /** - * @brief Checks if the contact is blocked + * Checks if the contact is blocked * * @param int $cid contact id * @@ -1732,7 +1732,7 @@ class Contact } /** - * @brief Checks if the contact is hidden + * Checks if the contact is hidden * * @param int $cid contact id * @@ -1753,7 +1753,7 @@ class Contact } /** - * @brief Returns posts from a given contact url + * Returns posts from a given contact url * * @param string $contact_url Contact URL * @@ -1816,7 +1816,7 @@ class Contact } /** - * @brief Returns the account type name + * Returns the account type name * * The function can be called with either the user or the contact array * @@ -1871,7 +1871,7 @@ class Contact } /** - * @brief Blocks a contact + * Blocks a contact * * @param int $cid * @return bool @@ -1885,7 +1885,7 @@ class Contact } /** - * @brief Unblocks a contact + * Unblocks a contact * * @param int $cid * @return bool @@ -1899,7 +1899,7 @@ class Contact } /** - * @brief Updates the avatar links in a contact only if needed + * Updates the avatar links in a contact only if needed * * @param string $avatar Link to avatar picture * @param int $uid User id of contact owner @@ -1949,8 +1949,8 @@ class Contact return $data; } - /** - * @brief Helper function for "updateFromProbe". Updates personal and public contact + /** + * Helper function for "updateFromProbe". Updates personal and public contact * * @param integer $id contact id * @param integer $uid user id @@ -2008,8 +2008,8 @@ class Contact DBA::update('contact', $fields, $condition); } - /** - * @brief Remove duplicated contacts + /** + * Remove duplicated contacts * * @param string $nurl Normalised contact url * @param integer $uid User id @@ -2244,7 +2244,7 @@ class Contact * $return['success'] boolean true if successful * $return['message'] error text if success is false. * - * @brief Takes a $uid and a url/handle and adds a new contact + * Takes a $uid and a url/handle and adds a new contact * @param int $uid * @param string $url * @param bool $interactive @@ -2474,7 +2474,7 @@ class Contact } /** - * @brief Updated contact's SSL policy + * Updated contact's SSL policy * * @param array $contact Contact array * @param string $new_policy New policy, valid: self,full @@ -2677,7 +2677,7 @@ class Contact } /** - * @brief Create a birthday event. + * Create a birthday event. * * Update the year and the birthday. */ @@ -2739,7 +2739,7 @@ class Contact } /** - * @brief Returns a magic link to authenticate remote visitors + * Returns a magic link to authenticate remote visitors * * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir * @@ -2768,7 +2768,7 @@ class Contact } /** - * @brief Returns a magic link to authenticate remote visitors + * Returns a magic link to authenticate remote visitors * * @param integer $cid The contact id of the target contact profile * @param string $url An url that we will be redirected to after the authentication @@ -2785,7 +2785,7 @@ class Contact } /** - * @brief Returns a magic link to authenticate remote visitors + * Returns a magic link to authenticate remote visitors * * @param array $contact The contact array with "uid", "network" and "url" * @param string $url An url that we will be redirected to after the authentication diff --git a/src/Model/Conversation.php b/src/Model/Conversation.php index 2ef58636a..78faaddf6 100644 --- a/src/Model/Conversation.php +++ b/src/Model/Conversation.php @@ -31,7 +31,7 @@ class Conversation } /** - * @brief Store the conversation data + * Store the conversation data * * @param array $arr Item array with conversation data * @return array Item array with removed conversation data diff --git a/src/Model/Event.php b/src/Model/Event.php index 48544b06d..4055ca63b 100644 --- a/src/Model/Event.php +++ b/src/Model/Event.php @@ -20,7 +20,7 @@ use Friendica\Util\Strings; use Friendica\Util\XML; /** - * @brief functions for interacting with the event database table + * functions for interacting with the event database table */ class Event { @@ -110,7 +110,7 @@ class Event } /** - * @brief Convert an array with event data to bbcode. + * Convert an array with event data to bbcode. * * @param array $event Array which contains the event data. * @return string The event as a bbcode formatted string. @@ -147,7 +147,7 @@ class Event } /** - * @brief Extract bbcode formatted event data from a string. + * Extract bbcode formatted event data from a string. * * @params: string $s The string which should be parsed for event data. * @param $text @@ -211,7 +211,7 @@ class Event } /** - * @brief Delete an event from the event table. + * Delete an event from the event table. * * Note: This function does only delete the event from the event table not its * related entry in the item table. @@ -231,7 +231,7 @@ class Event } /** - * @brief Store the event. + * Store the event. * * Store the event in the event table and create an event item in the item table. * @@ -370,7 +370,7 @@ class Event } /** - * @brief Create an array with translation strings used for events. + * Create an array with translation strings used for events. * * @return array Array with translations strings. * @throws \Friendica\Network\HTTPException\InternalServerErrorException @@ -441,7 +441,7 @@ class Event } /** - * @brief Removes duplicated birthday events. + * Removes duplicated birthday events. * * @param array $dates Array of possibly duplicated events. * @return array Cleaned events. @@ -463,7 +463,7 @@ class Event } /** - * @brief Get an event by its event ID. + * Get an event by its event ID. * * @param int $owner_uid The User ID of the owner of the event * @param int $event_id The ID of the event in the event table @@ -496,7 +496,7 @@ class Event } /** - * @brief Get all events in a specific time frame. + * Get all events in a specific time frame. * * @param int $owner_uid The User ID of the owner of the events. * @param array $event_params An associative array with @@ -546,7 +546,7 @@ class Event } /** - * @brief Convert an array query results in an array which could be used by the events template. + * Convert an array query results in an array which could be used by the events template. * * @param array $event_result Event query array. * @return array Event array for the template. @@ -631,7 +631,7 @@ class Event } /** - * @brief Format event to export format (ical/csv). + * Format event to export format (ical/csv). * * @param array $events Query result for events. * @param string $format The output format (ical/csv). @@ -738,7 +738,7 @@ class Event } /** - * @brief Get all events for a user ID. + * Get all events for a user ID. * * The query for events is done permission sensitive. * If the user is the owner of the calendar they @@ -832,7 +832,7 @@ class Event } /** - * @brief Format an item array with event data to HTML. + * Format an item array with event data to HTML. * * @param array $item Array with item and event data. * @return string HTML output. @@ -941,7 +941,7 @@ class Event } /** - * @brief Format a string with map bbcode to an array with location data. + * Format a string with map bbcode to an array with location data. * * Note: The string must only contain location data. A string with no bbcode will be * handled as location name. @@ -992,7 +992,7 @@ class Event } /** - * @brief Add new birthday event for this person + * Add new birthday event for this person * * @param array $contact Contact array, expects: id, uid, url, name * @param string $birthday Birthday of the contact diff --git a/src/Model/FileTag.php b/src/Model/FileTag.php index ffcea7e28..c7941db05 100644 --- a/src/Model/FileTag.php +++ b/src/Model/FileTag.php @@ -10,7 +10,7 @@ use Friendica\Database\DBA; use Friendica\DI; /** - * @brief This class handles FileTag related functions + * This class handles FileTag related functions * * post categories and "save to file" use the same item.file table for storage. * We will differentiate the different uses by wrapping categories in angle brackets @@ -20,7 +20,7 @@ use Friendica\DI; class FileTag { /** - * @brief URL encode <, >, left and right brackets + * URL encode <, >, left and right brackets * * @param string $s String to be URL encoded. * @@ -32,7 +32,7 @@ class FileTag } /** - * @brief URL decode <, >, left and right brackets + * URL decode <, >, left and right brackets * * @param string $s The URL encoded string to be decoded * @@ -44,7 +44,7 @@ class FileTag } /** - * @brief Query files for tag + * Query files for tag * * @param string $table The table to be queired. * @param string $s The search term @@ -124,7 +124,7 @@ class FileTag } /** - * @brief Get file tags from list + * Get file tags from list * * ex. given music,video return