Added documentation

diff --git a/include/plaintext.php b/include/plaintext.php
index 95236027b173b26f747b3b0a4c28e23292f5a9e5..c6e02a5b24f3e21352752ba033d7fa5e62d93dc2 100644 (file)
--- a/include/plaintext.php
+++ b/include/plaintext.php
@@ -1,4 +1,16 @@
 <?php
+/**
+ * @brief Fetches attachment data that were generated the old way
+ *
+ * @param string $body Message body
+ * @return array
+ * 'type' -> Message type ("link", "video", "photo")
+ * 'text' -> Text outside of the shared message
+ * 'image' -> Preview image of the message
+ * 'url' -> Url to the attached message
+ * 'title' -> Title of the attachment
+ * 'description' -> Description of the attachment
+ */
 function get_old_attachment_data($body) {
 
        $post = array();
@@ -37,6 +49,19 @@ function get_old_attachment_data($body) {
        return $post;
 }
 
+/**
+ * @brief Fetches attachment data that were generated with the "attachment" element
+ *
+ * @param string $body Message body
+ * @return array
+ * 'type' -> Message type ("link", "video", "photo")
+ * 'text' -> Text before the shared message
+ * 'after' -> Text after the shared message
+ * 'image' -> Preview image of the message
+ * 'url' -> Url to the attached message
+ * 'title' -> Title of the attachment
+ * 'description' -> Description of the attachment
+ */
 function get_attachment_data($body) {
 
        $data = array();