X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=library%2Fmarkdown.php;h=8def53fcbdaba4906f5ea5bf9403a97795079d29;hb=54d598ce7c66308dbcf5d5aa0b14b3aec73885a8;hp=e0b65ba0aa9847a28cff092249ac7bd31d90e495;hpb=839a457ab2390284da167d4289d44a24ff7f7cd8;p=friendica.git

diff --git a/library/markdown.php b/library/markdown.php
index e0b65ba0aa..8def53fcbd 100644
--- a/library/markdown.php
+++ b/library/markdown.php
@@ -1,26 +1,38 @@
 <?php
-//# Install PSR-0-compatible class autoloader
-//spl_autoload_register(function($class){
-//	require preg_replace('{\\\\|_(?!.*\\\\)}', DIRECTORY_SEPARATOR, ltrim($class, '\\')).'.php';
-//});
 
-require_once("library/php-markdown/Michelf/MarkdownExtra.inc.php");
-# Get Markdown class
+/**
+ * @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);
 
-	# Read file and pass content through the Markdown parser
 	$MarkdownParser = new MarkdownExtra();
-	$MarkdownParser->hard_wrap = true;
+	$MarkdownParser->hard_wrap = $hardwrap;
 	$html = $MarkdownParser->transform($text);
 
 	$a->save_timestamp($stamp1, "parser");
 
 	return $html;
 }
-?>