thunderer / Shortcode

src/Processor/Processor.php

Doc Comments +6 added lines

@@ -127,6 +127,9 @@ 
         return $text;
     }
 
+    /**
+     * @param callable|null $handler
+     */
     private function processHandler(ParsedShortcodeInterface $parsed, ProcessorContext $context, $handler)
     {
         $processed = ProcessedShortcode::createFromContext(clone $context);
@@ -144,6 +147,9 @@ 
         return mb_substr($state, 0, $offset, 'utf-8').$processed->getContent().mb_substr($state, $offset + $length, mb_strlen($state, 'utf-8'), 'utf-8');
     }
 
+    /**
+     * @return string
+     */
     private function processRecursion(ParsedShortcodeInterface $shortcode, ProcessorContext $context)
     {
         if ($this->autoProcessContent && null !== $shortcode->getContent()) {

src/Parser/RegularParser.php

Doc Comments +15 added lines

@@ -68,6 +68,11 @@ 
         return $shortcodes;
     }
 
+    /**
+     * @param string|null $bbCode
+     * @param null|string $content
+     * @param string $text
+     */
     private function getObject($name, $parameters, $bbCode, $offset, $content, $text)
     {
         return new ParsedShortcode(new Shortcode($name, $parameters, $content, $bbCode), $text, $offset);
@@ -247,11 +252,18 @@ 
         return $backtrack;
     }
 
+    /**
+     * @param integer $type
+     */
     private function lookahead($type)
     {
         return $this->position < $this->tokensCount && $this->tokens[$this->position][0] === $type;
     }
 
+    /**
+     * @param integer|null $type
+     * @param boolean $ws
+     */
     private function match($type, $ws)
     {
         if($this->position >= $this->tokensCount) {
@@ -273,6 +285,9 @@ 
 
     /* --- LEXER ----------------------------------------------------------- */
 
+    /**
+     * @param string $text
+     */
     private function tokenize($text)
     {
         $count = preg_match_all($this->lexerRegex, $text, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);