]> git.mxchange.org Git - friendica.git/blobdiff - library/php-markdown/Michelf/MarkdownInterface.php
Added a whitespace between comma and t()
[friendica.git] / library / php-markdown / Michelf / MarkdownInterface.php
index e4c2931f32b01a626e7e51275a66a8ee041b0bb1..8512e3753e99768049b1b0cfecb644ab717bbf0b 100644 (file)
@@ -1,34 +1,38 @@
 <?php
-#
-# Markdown  -  A text-to-HTML conversion tool for web writers
-#
-# PHP Markdown
-# Copyright (c) 2004-2014 Michel Fortin
-# <http://michelf.com/projects/php-markdown/>
-#
-# Original Markdown
-# Copyright (c) 2004-2006 John Gruber
-# <http://daringfireball.net/projects/markdown/>
-#
-namespace Michelf;
-
+/**
+ * Markdown  -  A text-to-HTML conversion tool for web writers
+ *
+ * @package   php-markdown
+ * @author    Michel Fortin <michel.fortin@michelf.com>
+ * @copyright 2004-2016 Michel Fortin <https://michelf.com/projects/php-markdown/>
+ * @copyright (Original Markdown) 2004-2006 John Gruber <https://daringfireball.net/projects/markdown/>
+ */
 
-#
-# Markdown Parser Interface
-#
+namespace Michelf;
 
+/**
+ * Markdown Parser Interface 
+ */
 interface MarkdownInterface {
+       /**
+        * Initialize the parser and return the result of its transform method.
+        * This will work fine for derived classes too.
+        *
+        * @api
+        *
+        * @param  string $text
+        * @return string
+        */
+       public static function defaultTransform($text);
 
-  #
-  # Initialize the parser and return the result of its transform method.
-  # This will work fine for derived classes too.
-  #
-  public static function defaultTransform($text);
-
-  #
-  # Main function. Performs some preprocessing on the input text
-  # and pass it through the document gamut.
-  #
-  public function transform($text);
-
+       /**
+        * Main function. Performs some preprocessing on the input text
+        * and pass it through the document gamut.
+        *
+        * @api
+        *
+        * @param  string $text
+        * @return string
+        */
+       public function transform($text);
 }