[#98] Changing to PHPDoc comments
This commit is contained in:
Robbie Averill
parent
156e56ee03
commit
f5cd0dbcf4
8 changed files with 1503 additions and 1055 deletions
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,16 @@
|
|||
<?php
|
||||
|
||||
# Use this file if you cannot use class autoloading. It will include all the
|
||||
# files needed for the Markdown parser.
|
||||
#
|
||||
# Take a look at the PSR-0-compatible class autoloading implementation
|
||||
# in the Readme.php file if you want a simple autoloader setup.
|
||||
/**
|
||||
* Use this file if you cannot use class autoloading. It will include all the
|
||||
* files needed for the Markdown parser.
|
||||
*
|
||||
* Take a look at the PSR-0-compatible class autoloading implementation
|
||||
* in the Readme.php file if you want a simple autoloader setup.
|
||||
*
|
||||
* @package php-markdown
|
||||
* @author Michael Fortin <michael.fortin@michaelf.com>
|
||||
* @copyright 2004-2016 Michel Fortin <http://michelf.com/projects/php-markdown/>
|
||||
* @copyright (Original Markdown) 2004-2006 John Gruber <http://daringfireball.net/projects/markdown/>
|
||||
*/
|
||||
|
||||
require_once dirname(__FILE__) . '/MarkdownInterface.php';
|
||||
require_once dirname(__FILE__) . '/Markdown.php';
|
||||
|
|
|
|||
1228
Michelf/Markdown.php
1228
Michelf/Markdown.php
File diff suppressed because it is too large
Load diff
|
|
@ -1,10 +1,16 @@
|
|||
<?php
|
||||
|
||||
# Use this file if you cannot use class autoloading. It will include all the
|
||||
# files needed for the MarkdownExtra parser.
|
||||
#
|
||||
# Take a look at the PSR-0-compatible class autoloading implementation
|
||||
# in the Readme.php file if you want a simple autoloader setup.
|
||||
/**
|
||||
* Use this file if you cannot use class autoloading. It will include all the
|
||||
* files needed for the MarkdownExtra parser.
|
||||
*
|
||||
* Take a look at the PSR-0-compatible class autoloading implementation
|
||||
* in the Readme.php file if you want a simple autoloader setup.
|
||||
*
|
||||
* @package php-markdown
|
||||
* @author Michael Fortin <michael.fortin@michaelf.com>
|
||||
* @copyright 2004-2016 Michel Fortin <http://michelf.com/projects/php-markdown/>
|
||||
* @copyright (Original Markdown) 2004-2006 John Gruber <http://daringfireball.net/projects/markdown/>
|
||||
*/
|
||||
|
||||
require_once dirname(__FILE__) . '/MarkdownInterface.php';
|
||||
require_once dirname(__FILE__) . '/Markdown.php';
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -1,9 +1,15 @@
|
|||
<?php
|
||||
|
||||
# Use this file if you cannot use class autoloading. It will include all the
|
||||
# files needed for the MarkdownInterface interface.
|
||||
#
|
||||
# Take a look at the PSR-0-compatible class autoloading implementation
|
||||
# in the Readme.php file if you want a simple autoloader setup.
|
||||
/**
|
||||
* Use this file if you cannot use class autoloading. It will include all the
|
||||
* files needed for the MarkdownInterface interface.
|
||||
*
|
||||
* Take a look at the PSR-0-compatible class autoloading implementation
|
||||
* in the Readme.php file if you want a simple autoloader setup.
|
||||
*
|
||||
* @package php-markdown
|
||||
* @author Michael Fortin <michael.fortin@michaelf.com>
|
||||
* @copyright 2004-2016 Michel Fortin <http://michelf.com/projects/php-markdown/>
|
||||
* @copyright (Original Markdown) 2004-2006 John Gruber <http://daringfireball.net/projects/markdown/>
|
||||
*/
|
||||
|
||||
require_once dirname(__FILE__) . '/MarkdownInterface.php';
|
||||
|
|
|
|||
|
|
@ -1,34 +1,38 @@
|
|||
<?php
|
||||
#
|
||||
# Markdown - A text-to-HTML conversion tool for web writers
|
||||
#
|
||||
# PHP Markdown
|
||||
# Copyright (c) 2004-2015 Michel Fortin
|
||||
# <https://michelf.ca/projects/php-markdown/>
|
||||
#
|
||||
# Original Markdown
|
||||
# Copyright (c) 2004-2006 John Gruber
|
||||
# <https://daringfireball.net/projects/markdown/>
|
||||
#
|
||||
/**
|
||||
* Markdown - A text-to-HTML conversion tool for web writers
|
||||
*
|
||||
* @package php-markdown
|
||||
* @author Michael Fortin <michael.fortin@michaelf.com>
|
||||
* @copyright 2004-2016 Michel Fortin <http://michelf.com/projects/php-markdown/>
|
||||
* @copyright (Original Markdown) 2004-2006 John Gruber <http://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.
|
||||
# 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);
|
||||
}
|
||||
|
|
|
|||
42
Readme.php
42
Readme.php
|
|
@ -1,31 +1,41 @@
|
|||
<?php
|
||||
/**
|
||||
* 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
|
||||
* you like.
|
||||
*
|
||||
* @package php-markdown
|
||||
* @author Michael Fortin <michael.fortin@michaelf.com>
|
||||
* @copyright 2004-2016 Michel Fortin <http://michelf.com/projects/php-markdown/>
|
||||
* @copyright (Original Markdown) 2004-2006 John Gruber <http://daringfireball.net/projects/markdown/>
|
||||
*/
|
||||
|
||||
# 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
|
||||
# you like.
|
||||
|
||||
# Install PSR-0-compatible class autoloader
|
||||
spl_autoload_register(function($class){
|
||||
require preg_replace('{\\\\|_(?!.*\\\\)}', DIRECTORY_SEPARATOR, ltrim($class, '\\')).'.php';
|
||||
// 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);
|
||||
|
||||
?>
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>PHP Markdown Lib - Readme</title>
|
||||
</head>
|
||||
<body>
|
||||
<head>
|
||||
<title>PHP Markdown Lib - Readme</title>
|
||||
</head>
|
||||
<body>
|
||||
<?php
|
||||
# Put HTML content in the document
|
||||
echo $html;
|
||||
// Put HTML content in the document
|
||||
echo $html;
|
||||
?>
|
||||
</body>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
Loading…
Reference in a new issue