@brief is removed completely

This commit is contained in:
Michael 2020-01-19 06:05:23 +00:00
parent fd1f1999f0
commit 0a4119adaf
170 changed files with 901 additions and 962 deletions

View file

@ -11,7 +11,7 @@ use Friendica\Util\Arrays;
use Friendica\Util\DateTimeFormat;
/**
* @brief Admin Inspect Queue Page
* Admin Inspect Queue Page
*
* Generates a page for the admin to have a look into the current queue of
* worker jobs. Shown are the parameters for the job and its priority.

View file

@ -14,12 +14,12 @@ use Friendica\DI;
use Friendica\Model\Attach as MAttach;
/**
* @brief Attach Module
* Attach Module
*/
class Attach extends BaseModule
{
/**
* @brief Return to user an attached file given the id
* Return to user an attached file given the id
*/
public static function rawContent(array $parameters = [])
{

View file

@ -51,9 +51,8 @@ class Api extends BaseModule
/**
* Log in user via OAuth1 or Simple HTTP Auth.
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
*
* @brief Login API user
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
*
* @return bool Was a user authenticated?
* @throws HTTPException\ForbiddenException
@ -76,7 +75,7 @@ class Api extends BaseModule
}
/**
* @brief Get user info array.
* Get user info array.
*
* @param int|string $contact_id Contact ID or URL
* @return array|bool

View file

@ -27,8 +27,6 @@ use Friendica\Util\Strings;
/**
* Manages and show Contacts and their content
*
* @brief manages contacts
*/
class Contact extends BaseModule
{
@ -837,7 +835,7 @@ class Contact extends BaseModule
}
/**
* @brief List of pages for the Contact TabBar
* List of pages for the Contact TabBar
*
* Available Pages are 'Status', 'Profile', 'Contacts' and 'Common Friends'
*
@ -1049,7 +1047,7 @@ class Contact extends BaseModule
}
/**
* @brief Gives a array with actions which can performed to a given contact
* Gives a array with actions which can performed to a given contact
*
* This includes actions like e.g. 'block', 'hide', 'archive', 'delete' and others
*

View file

@ -18,8 +18,6 @@ use Friendica\Protocol\OStatus;
*
* The nocache GET parameter is provided mainly for debug purposes, requires auth
*
* @brief Provides public Atom feeds
*
* @author Hypolite Petovan <hypolite@mrpetovan.com>
*/
class Feed extends BaseModule

View file

@ -14,7 +14,7 @@ use Friendica\Util\HTTPSignature;
use Friendica\Util\Strings;
/**
* @brief OpenWebAuth verifier and token generator
* OpenWebAuth verifier and token generator
*
* See https://macgirvin.com/wiki/mike/OpenWebAuth/Home
* Requests to this endpoint should be signed using HTTP Signatures

View file

@ -14,12 +14,12 @@ use Friendica\Model\Photo as MPhoto;
use Friendica\Object\Image;
/**
* @brief Photo Module
* Photo Module
*/
class Photo extends BaseModule
{
/**
* @brief Module initializer
* Module initializer
*
* Fetch a photo or an avatar, in optional size, check for permissions and
* return the image

View file

@ -1,7 +1,7 @@
<?php
/**
* @file src/Module/Proxy.php
* @brief Based upon "Privacy Image Cache" by Tobias Hößl <https://github.com/CatoTH/>
* Based upon "Privacy Image Cache" by Tobias Hößl <https://github.com/CatoTH/>
*/
namespace Friendica\Module;
@ -16,7 +16,7 @@ use Friendica\Util\HTTPSignature;
use Friendica\Util\Proxy as ProxyUtils;
/**
* @brief Module Proxy
* Module Proxy
*
* urls:
* /proxy/[sub1/[sub2/]]<base64url image url>[.ext][:size]
@ -26,7 +26,7 @@ class Proxy extends BaseModule
{
/**
* @brief Initializer method for this class.
* Initializer method for this class.
*
* Sets application instance and checks if /proxy/ path is writable.
*
@ -144,7 +144,7 @@ class Proxy extends BaseModule
/**
* @brief Build info about requested image to be proxied
* Build info about requested image to be proxied
*
* @return array
* [
@ -224,7 +224,7 @@ class Proxy extends BaseModule
/**
* @brief setup ./proxy folder for direct cache
* setup ./proxy folder for direct cache
*
* @return bool False if direct cache can't be used.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
@ -249,7 +249,7 @@ class Proxy extends BaseModule
/**
* @brief Try to reply with image in cachefile
* Try to reply with image in cachefile
*
* @param array $request Array from getRequestInfo
*
@ -271,7 +271,7 @@ class Proxy extends BaseModule
}
/**
* @brief Try to reply with image in database
* Try to reply with image in database
*
* @param array $request Array from getRequestInfo
*
@ -301,7 +301,7 @@ class Proxy extends BaseModule
}
/**
* @brief Output the image with cache headers
* Output the image with cache headers
*
* @param Image $img
* @throws \Friendica\Network\HTTPException\InternalServerErrorException

View file

@ -26,7 +26,7 @@ class Register extends BaseModule
const OPEN = 2;
/**
* @brief Module GET method to display any content
* Module GET method to display any content
*
* Extend this method if the module is supposed to return any display
* through a GET request. It can be an HTML page through templating or a
@ -158,7 +158,7 @@ class Register extends BaseModule
}
/**
* @brief Module POST method to process submitted data
* Module POST method to process submitted data
*
* Extend this method if the module is supposed to process POST requests.
* Doesn't display any content

View file

@ -60,7 +60,7 @@ class Login extends BaseModule
}
/**
* @brief Wrapper for adding a login box.
* Wrapper for adding a login box.
*
* @param string $return_path The path relative to the base the user should be sent
* back to after login completes

View file

@ -19,7 +19,7 @@ use Friendica\Model\Profile;
class Logout extends BaseModule
{
/**
* @brief Process logout requests
* Process logout requests
*/
public static function init(array $parameters = [])
{

View file

@ -24,7 +24,7 @@ class Tos extends BaseModule
public $privacy_complete;
/**
* @brief constructor for the module, initializing the text variables
* constructor for the module, initializing the text variables
*
* To make the text variables available outside of the module, they need to
* be properties of the class, however cannot be set directly as the property
@ -41,7 +41,7 @@ class Tos extends BaseModule
}
/**
* @brief initialize the TOS module.
* initialize the TOS module.
*
* If this is a single user instance, we expect the user to know their
* dealings with their own node so a TOS is not necessary.
@ -55,7 +55,7 @@ class Tos extends BaseModule
}
/**
* @brief generate the content of the /tos page
* generate the content of the /tos page
*
* The content of the /tos page is generated from two parts.
* (1) a free form part the admin of the node can set in the admin panel