Merge branch 'issue/98-phpdoc-comments' of git://github.com/robbieaverill/php-markdown into lib

Reverted some changes to Readme.php and the .inc files and corrected a syntax error in MarkdownExtra.php.

License.md

@@ -1,5 +1,5 @@
 PHP Markdown Lib  
-Copyright (c) 2004-2015 Michel Fortin  
+Copyright (c) 2004-2016 Michel Fortin  
 <https://michelf.ca/>  
 All rights reserved.
 

Michelf/Markdown.inc.php

@@ -1,10 +1,10 @@
 <?php
 
-# Use this file if you cannot use class autoloading. It will include all the
+// Use this file if you cannot use class autoloading. It will include all the
-# files needed for the Markdown parser.
+// files needed for the Markdown parser.
-#
+//
-# Take a look at the PSR-0-compatible class autoloading implementation
+// Take a look at the PSR-0-compatible class autoloading implementation
-# in the Readme.php file if you want a simple autoloader setup.
+// in the Readme.php file if you want a simple autoloader setup.
 
 require_once dirname(__FILE__) . '/MarkdownInterface.php';
 require_once dirname(__FILE__) . '/Markdown.php';

Michelf/MarkdownExtra.inc.php

@@ -1,10 +1,10 @@
 <?php
 
-# Use this file if you cannot use class autoloading. It will include all the
+// Use this file if you cannot use class autoloading. It will include all the
-# files needed for the MarkdownExtra parser.
+// files needed for the MarkdownExtra parser.
-#
+//
-# Take a look at the PSR-0-compatible class autoloading implementation
+// Take a look at the PSR-0-compatible class autoloading implementation
-# in the Readme.php file if you want a simple autoloader setup.
+// in the Readme.php file if you want a simple autoloader setup.
 
 require_once dirname(__FILE__) . '/MarkdownInterface.php';
 require_once dirname(__FILE__) . '/Markdown.php';

Michelf/MarkdownInterface.inc.php

@@ -1,9 +1,9 @@
 <?php
 
-# Use this file if you cannot use class autoloading. It will include all the
+// Use this file if you cannot use class autoloading. It will include all the
-# files needed for the MarkdownInterface interface.
+// files needed for the MarkdownInterface interface.
-#
+//
-# Take a look at the PSR-0-compatible class autoloading implementation
+// Take a look at the PSR-0-compatible class autoloading implementation
-# in the Readme.php file if you want a simple autoloader setup.
+// in the Readme.php file if you want a simple autoloader setup.
 
 require_once dirname(__FILE__) . '/MarkdownInterface.php';

Michelf/MarkdownInterface.php

@@ -1,34 +1,38 @@
 <?php
-#
+/**
-# Markdown  -  A text-to-HTML conversion tool for web writers
+ * Markdown  -  A text-to-HTML conversion tool for web writers
-#
+ *
-# PHP Markdown
+ * @package   php-markdown
-# Copyright (c) 2004-2015 Michel Fortin
+ * @author    Michel Fortin <michel.fortin@michelf.com>
-# <https://michelf.ca/projects/php-markdown/>
+ * @copyright 2004-2016 Michel Fortin <http://michelf.com/projects/php-markdown/>
-#
+ * @copyright (Original Markdown) 2004-2006 John Gruber <http://daringfireball.net/projects/markdown/>
-# Original Markdown
+ */
-# Copyright (c) 2004-2006 John Gruber
+
-# <https://daringfireball.net/projects/markdown/>
-#
 namespace Michelf;
 
-
+/**
-#
+ * Markdown Parser Interface 
-# 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.
+	 * Main function. Performs some preprocessing on the input text
-  # This will work fine for derived classes too.
+	 * and pass it through the document gamut.
-  #
+	 *
-  public static function defaultTransform($text);
+	 * @api
-
+	 *
-  #
+	 * @param  string $text
-  # Main function. Performs some preprocessing on the input text
+	 * @return string
-  # and pass it through the document gamut.
+	 */
-  #
+	public function transform($text);
-  public function transform($text);
-
 }

Readme.php

@@ -1,18 +1,18 @@
 <?php
 
-# This file passes the content of the Readme.md file in the same directory
+// This file passes the content of the Readme.md file in the same directory
-# through the Markdown filter. You can adapt this sample code in any way
+// through the Markdown filter. You can adapt this sample code in any way
-# you like.
+// you like.
 
-# Install PSR-0-compatible class autoloader
+// Install PSR-0-compatible class autoloader
 spl_autoload_register(function($class){
 	require preg_replace('{\\\\|_(?!.*\\\\)}', DIRECTORY_SEPARATOR, ltrim($class, '\\')).'.php';
 });
 
-# Get Markdown class
+// Get Markdown class
 use \Michelf\Markdown;
 
-# Read file and pass content through the Markdown parser
+// Read file and pass content through the Markdown parser
 $text = file_get_contents('Readme.md');
 $html = Markdown::defaultTransform($text);
 
@@ -24,7 +24,7 @@ $html = Markdown::defaultTransform($text);
     </head>
     <body>
 		<?php
-			# Put HTML content in the document
+			// Put HTML content in the document
 			echo $html;
 		?>
     </body>