From: Michael Vogel Date: Tue, 23 Feb 2016 06:56:49 +0000 (+0100) Subject: Added documentation X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=148c89a20d3fa75904f87d4b7fc0e70077ace85a;p=friendica.git Added documentation --- diff --git a/include/plaintext.php b/include/plaintext.php index 199abcbb31..a2b2c56522 100644 --- a/include/plaintext.php +++ b/include/plaintext.php @@ -132,6 +132,18 @@ function shortenmsg($msg, $limit, $twitter = false) { return($msg); } +/** + * @brief Convert a message into plaintext for connectors to other networks + * + * @param App $a The application class + * @param array $b The message array that is about to be posted + * @param int $limit The maximum number of characters when posting to that network + * @param bool $includedlinks Has an attached link to be included into the message? + * @param int $htmlmode This triggers the behaviour of the bbcode conversion + * @param string $target_network Name of the network where the post should go to. + * + * @return string The converted message + */ function plaintext($a, $b, $limit = 0, $includedlinks = false, $htmlmode = 2, $target_network = "") { require_once("include/bbcode.php"); require_once("include/html2plain.php");