X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=library%2Fphp-markdown%2FMichelf%2FMarkdownInterface.php;h=8512e3753e99768049b1b0cfecb644ab717bbf0b;hb=3b28f5a992fb09801316ec05a24f8c5ca782f47c;hp=e4c2931f32b01a626e7e51275a66a8ee041b0bb1;hpb=5837fd4f817c06a723af9ad27298b6bef40e37e5;p=friendica.git
diff --git a/library/php-markdown/Michelf/MarkdownInterface.php b/library/php-markdown/Michelf/MarkdownInterface.php
index e4c2931f32..8512e3753e 100644
--- a/library/php-markdown/Michelf/MarkdownInterface.php
+++ b/library/php-markdown/Michelf/MarkdownInterface.php
@@ -1,34 +1,38 @@
-#
-# Original Markdown
-# Copyright (c) 2004-2006 John Gruber
-#
-#
-namespace Michelf;
-
+/**
+ * Markdown - A text-to-HTML conversion tool for web writers
+ *
+ * @package php-markdown
+ * @author Michel Fortin
+ * @copyright 2004-2016 Michel Fortin
+ * @copyright (Original Markdown) 2004-2006 John Gruber
+ */
-#
-# 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);
}