Changeset 3511 for sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-markdown.php

Timestamp:

06/20/2016 05:34:18 PM (10 years ago)

Author:

obenland

Message:

Plugin Directory: Documentation and formatting updates.

See #1584.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-markdown.php (modified) (4 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-markdown.php

@@ -15 +15 @@
 class Markdown extends \Michelf\MarkdownExtra {
 
+        /**
+         * @param string $text
+         * @return string
+         */
         public function transform( $text ) {
                 $text = $this->code_trick( trim( $text ) );
-                // Convert any `= Section =` headers into a real header
+
+                // Convert any `= Section =` headers into a real header.
                 $text = preg_replace( '/^[\s]*=[\s]+(.+?)[\s]+=/m', "\n" . '<h4>$1</h4>' . "\n", $text );
 
@@ -25 +30 @@
         }
 
+        /**
+         * @access protected
+         *
+         * @param string $text
+         * @return string
+         */
         protected function code_trick( $text ) {
-                // when doing markdown, first take any user formatted code blocks and turn them into backticks so that
-                // markdown will preserve things like underscores in code blocks
+
+                /*
+                 * When doing markdown, first take any user formatted code blocks and turn them into backticks so that
+                 * markdown will preserve things like underscores in code blocks.
+                 */
                 $text = preg_replace_callback( "!(<pre><code>|<code>)(.*?)(</code></pre>|</code>)!s", array( $this, 'code_trick_decodeit_cb' ), $text );
                 $text = str_replace( array( "\r\n", "\r" ), "\n", $text );
 
-                // Markdown can do inline code, we convert bbPress style block level code to Markdown style
+                // Markdown can do inline code, we convert bbPress style block level code to Markdown style.
                 $text = preg_replace_callback( "!(^|\n)([ \t]*?)`(.*?)`!s", array( $this, 'code_trick_indent_cb' ), $text );
 
@@ -37 +51 @@
         }
 
+        /**
+         * @access protected
+         *
+         * @param array $matches
+         * @return string
+         */
         protected function code_trick_indent_cb( $matches ) {
                 $text = $matches[3];
@@ -44 +64 @@
         }
 
+        /**
+         * @access protected
+         *
+         * @param array $matches
+         * @return string
+         */
         protected function code_trick_decodeit_cb( $matches ) {
-                $text        = $matches[2];
                 $trans_table = array_flip( get_html_translation_table( HTML_ENTITIES ) );
-                $text        = strtr( $text, $trans_table );
-                $text        = str_replace( '<br />', '', $text );
-                $text        = str_replace( '&#38;', '&', $text );
-                $text        = str_replace( '&#39;', "'", $text );
+
+                $text = $matches[2];
+                $text = strtr( $text, $trans_table );
+                $text = str_replace( '<br />', '', $text );
+                $text = str_replace( '&#38;', '&', $text );
+                $text = str_replace( '&#39;', "'", $text );
 
                 if ( '<pre><code>' == $matches[1] ) {