From eb511b3fefb94c2852f39a8cb96192feebc0ba1e Mon Sep 17 00:00:00 2001 From: Michael Vogel Date: Mon, 21 Mar 2016 19:58:45 +0100 Subject: [PATCH] Some more documentation - to make @rabuzarus happy --- include/diaspora.php | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/include/diaspora.php b/include/diaspora.php index 59bad946e..6f30ab924 100644 --- a/include/diaspora.php +++ b/include/diaspora.php @@ -116,7 +116,7 @@ class diaspora { * @param string $handle The handle of the signature owner * @param integer $level This value is only set inside this function to avoid endless loops * - * @return the repaired signature + * @return string the repaired signature */ function repair_signature($signature, $handle = "", $level = 1) { @@ -179,16 +179,6 @@ class diaspora { $decrypted = pkcs5_unpad($decrypted); - /** - * $decrypted now contains something like - * - * - * 8e+G2+ET8l5BPuW0sVTnQw== - * UvSMb4puPeB14STkcDWq+4QE302Edu15oaprAQSkLKU= - * galaxor@diaspora.priateship.org - * - */ - logger('decrypted: '.$decrypted, LOGGER_DEBUG); $idom = parse_xml_string($decrypted,false); @@ -795,7 +785,7 @@ class diaspora { } /** - * @brief sub function of "fetch_guid" + * @brief sub function of "fetch_guid" which checks for links in messages * * @param array $match array containing a link that has to be checked for a message link * @param array $item The item array @@ -838,7 +828,10 @@ class diaspora { * @param string $server The url of the server * @param int $level Endless loop prevention * - * @return array of message, author and public key + * @return array + * 'message' => The message XML + * 'author' => The author handle + * 'key' => The public key of the author */ private function message($guid, $server, $level = 0) {