Added documentation

diff --git a/include/ostatus.php b/include/ostatus.php
index 138f51090607abf8860e11723e88ed78a55a8dc8..54b70e6d6c8482c1285aec9a5f6bfa26f4dda5e9 100644 (file)
--- a/include/ostatus.php
+++ b/include/ostatus.php
@@ -676,13 +676,21 @@ function ostatus_conv_fetch_actor($actor) {
        update_gcontact($contact);
 }
 
-function ostatus_fetch_conversation($self, $conversation_url = "") {
+/**
+ * @brief Fetches the conversation url for a given item link or conversation id
+ *
+ * @param string $self The link to the posting
+ * @param string $conversation_id The conversation id
+ *
+ * @return string The conversation url
+ */
+function ostatus_fetch_conversation($self, $conversation_id = "") {
 
-       if ($conversation_url != "") {
-               $elements = explode(":", $conversation_url);
+       if ($conversation_id != "") {
+               $elements = explode(":", $conversation_id);
 
                if ((count($elements) <= 2) OR ($elements[0] != "tag"))
-                       return $conversation_url;
+                       return $conversation_id;
        }
 
        if ($self == "")