X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=library%2Fmarkdown.php;h=00696d2fe0b6d0102fd90ca564e746fe1878ea5c;hb=29a66c8336cb127f9a927e1c5cd317f3b9fde9f2;hp=769bdb1219745fd68e338cc2de97f161c6477d48;hpb=3b28f5a992fb09801316ec05a24f8c5ca782f47c;p=friendica.git

diff --git a/library/markdown.php b/library/markdown.php
index 769bdb1219..00696d2fe0 100644
--- a/library/markdown.php
+++ b/library/markdown.php
@@ -1,14 +1,39 @@
 <?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;
+	if ($hardwrap) {
+		$MarkdownParser->hard_wrap = true;
+	} else {
+		$MarkdownParser->hard_wrap = false;
+	}
 	$html = $MarkdownParser->transform($text);
 
 	$a->save_timestamp($stamp1, "parser");