Merge pull request #3874 from tobiasd/20171009-checkversion

[friendica.git] / library / markdown.php

diff --git a/library/markdown.php b/library/markdown.php
index 769bdb1219745fd68e338cc2de97f161c6477d48..8def53fcbdaba4906f5ea5bf9403a97795079d29 100644 (file)
--- a/library/markdown.php
+++ b/library/markdown.php
@@ -1,14 +1,35 @@
 <?php
+
+/**
+ * @file library/markdown.php
+ *
+ * @brief Parser for Markdown files
+ */
+
 require_once "library/php-markdown/Michelf/MarkdownExtra.inc.php";
 use \Michelf\MarkdownExtra;
 
-function Markdown($text) {
+/**
+ * @brief This function parses a text using php-markdown library to render Markdown syntax to HTML
+ *
+ * This function is using the php-markdown library by Michel Fortin to parse a 
+ * string ($text).It returns the rendered HTML code from that text. The optional 
+ * $hardwrap parameter is used to switch between inserting hard breaks after
+ * every linefeed, which is required for Diaspora compatibility, or not. The
+ * later is used for parsing documentation and README.md files.
+ *
+ * @param string $text
+ * @param boolean $hardwrap
+ * @return string
+ */
+
+function Markdown($text, $hardwrap = true) {
        $a = get_app();
 
        $stamp1 = microtime(true);
 
        $MarkdownParser = new MarkdownExtra();
-       $MarkdownParser->hard_wrap = true;
+       $MarkdownParser->hard_wrap = $hardwrap;
        $html = $MarkdownParser->transform($text);
 
        $a->save_timestamp($stamp1, "parser");