Intellivoid
/
MarkdownParser
mirror of https://git.netkas.me/intellivoid/MarkdownParser.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

improve comments

This commit is contained in:
Emanuil Rusev 2014-01-29 02:14:59 +02:00
parent 3d581dcaa9
commit 215ff63594
1 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
Parsedown.php
View File

@ -49,12 +49,18 @@ class Parsedown
private $breaks_enabled = false; private $breaks_enabled = false;
# #
# Methods # Synopsis
# #
# Parsedown tries to read Markdown texts the way humans do. First, it breaks # Markdown is intended to be easy-to-read by humans - those of us who read
# texts into lines. Then, it identifies blocks by looking at how these lines # line by line, left to right, top to bottom. In order to take advantage of
# start and relate to each other. Finally, it identifies inline elements. # this, Parsedown tries to read in a similar way. It breaks texts into
# lines, it iterates through them and it looks at how they start and relate
# to each other.
#
# Methods
#
function parse($text) function parse($text)
{ {
@ -82,7 +88,6 @@ class Parsedown
# #
# Private # Private
#
private function parse_block_elements(array $lines, $context = '') private function parse_block_elements(array $lines, $context = '')
{ {
@ -94,7 +99,7 @@ class Parsedown
foreach ($lines as $line) foreach ($lines as $line)
{ {
# fenced blocks # context
switch ($block['type']) switch ($block['type'])
{ {
@ -150,10 +155,12 @@ class Parsedown
break; break;
} }
# * # ~
$deindented_line = ltrim($line); $deindented_line = ltrim($line);
# blank
if ($deindented_line === '') if ($deindented_line === '')
{ {
$block['interrupted'] = true; $block['interrupted'] = true;
@ -161,7 +168,7 @@ class Parsedown
continue; continue;
} }
# composite blocks # context
switch ($block['type']) switch ($block['type'])
{ {
@ -237,7 +244,7 @@ class Parsedown
{ {
case ' ': case ' ':
# code block # code
if (isset($line[3]) and $line[3] === ' ' and $line[2] === ' ' and $line[1] === ' ') if (isset($line[3]) and $line[3] === ' ' and $line[2] === ' ' and $line[1] === ' ')
{ {
@ -298,7 +305,7 @@ class Parsedown
case '-': case '-':
case '=': case '=':
# setext heading # setext heading (===)
if ($block['type'] === 'paragraph' and isset($block['interrupted']) === false) if ($block['type'] === 'paragraph' and isset($block['interrupted']) === false)
{ {
@ -506,7 +513,7 @@ class Parsedown
} }
} }
# li # list item
if ($deindented_line[0] <= '9' and $deindented_line[0] >= '0' and preg_match('/^([ ]*)\d+[.][ ](.*)/', $line, $matches)) if ($deindented_line[0] <= '9' and $deindented_line[0] >= '0' and preg_match('/^([ ]*)\d+[.][ ](.*)/', $line, $matches))
{ {
@ -563,9 +570,7 @@ class Parsedown
unset($blocks[0]); unset($blocks[0]);
# # $blocks » HTML
# ~
#
$markup = ''; $markup = '';
@ -1061,7 +1066,6 @@ class Parsedown
# #
# Read-only # Read-only
#
private static $strong_regex = array( private static $strong_regex = array(
'*' => '/^[*]{2}([^*]+?)[*]{2}(?![*])/s', '*' => '/^[*]{2}([^*]+?)[*]{2}(?![*])/s',