Mistralys / mailcode

src/Mailcode/Parser/Safeguard/Formatter/FormatType.php

Indentation +5 added lines, -5 removed lines

@@ -25,11 +25,11 @@
         return PHP_INT_MAX;
     }
 
-   /**
-    * Formats the specified string according to the formatter.
-    * Retrieve the updated string from the string container used
-    * to create the formatter, or use `getSubjectString()`.
-    */
+    /**
+     * Formats the specified string according to the formatter.
+     * Retrieve the updated string from the string container used
+     * to create the formatter, or use `getSubjectString()`.
+     */
     public function format() : void
     {
         $locations = $this->resolveLocations();

src/Mailcode/Parser/Statement/Info.php

Indentation +64 added lines, -64 removed lines

@@ -21,14 +21,14 @@ 
  */
 class Mailcode_Parser_Statement_Info
 {
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer
+     */
     protected $tokenizer;
     
-   /**
-    * @var Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * @var Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     protected $tokens = array();
 
     /**
@@ -52,21 +52,21 @@ 
         $this->tokenizer->onTokensChanged(array($this, 'handleTokensChanged'));
     }
     
-   /**
-    * Whether the whole statement is a variable being assigned a value.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the whole statement is a variable being assigned a value.
+     * 
+     * @return bool
+     */
     public function isVariableAssignment() : bool
     {
         return $this->variables->isAssignment();
     }
     
-   /**
-    * Whether the whole statement is a variable being compared to something.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the whole statement is a variable being compared to something.
+     * 
+     * @return bool
+     */
     public function isVariableComparison() : bool
     {
         return $this->variables->isComparison();
@@ -83,27 +83,27 @@ 
         return $this->variables->getAll();
     }
     
-   /**
-    * Retrieves a variable by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    * 
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
-    */
+    /**
+     * Retrieves a variable by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     * 
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
+     */
     public function getVariableByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Variable
     {
         return $this->variables->getByIndex($index);
     }
     
-   /**
-    * Retrieves a string literal by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
-    */
+    /**
+     * Retrieves a string literal by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
+     */
     public function getStringLiteralByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral
     {
         $token = $this->getTokenByIndex($index);
@@ -116,27 +116,27 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a keyword by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
-    */
+    /**
+     * Retrieves a keyword by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Keyword|NULL
+     */
     public function getKeywordByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Keyword
     {
         return $this->keywords->getByIndex($index);
     }
     
-   /**
-    * Retrieves an operand by its position in the command's parameters.
-    * Returns null if there is no parameter at the specified index, or
-    * if it is of another type.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
-    */
+    /**
+     * Retrieves an operand by its position in the command's parameters.
+     * Returns null if there is no parameter at the specified index, or
+     * if it is of another type.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Operand|NULL
+     */
     public function getOperandByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token_Operand
     {
         $token = $this->getTokenByIndex($index);
@@ -149,14 +149,14 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a parameter token by its position in the command's parameters,
-    * regardless of its type. Returns null if there is no parameter at the 
-    * specified index.
-    *
-    * @param int $index Zero-based index.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
-    */
+    /**
+     * Retrieves a parameter token by its position in the command's parameters,
+     * regardless of its type. Returns null if there is no parameter at the 
+     * specified index.
+     *
+     * @param int $index Zero-based index.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token|NULL
+     */
     public function getTokenByIndex(int $index) : ?Mailcode_Parser_Statement_Tokenizer_Token
     {
         if(isset($this->tokens[$index]))
@@ -172,19 +172,19 @@ 
         return isset($this->tokens[$index]);
     }
     
-   /**
-    * Retrieves all tokens.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * Retrieves all tokens.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     public function getTokens() : array
     {
         return $this->tokens;
     }
     
-   /**
-    * Retrieves all string literals that were found in the command.
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
-    */
+    /**
+     * Retrieves all string literals that were found in the command.
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
+     */
     public function getStringLiterals() : array
     {
         $result = array();

src/Mailcode/Renderer.php

Indentation +15 added lines, -15 removed lines

@@ -21,17 +21,17 @@ 
  */
 class Mailcode_Renderer
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $highlighted = false;
     
-   /**
-    * Sets whether to output highlighted commands instead of the default plain text.
-    * 
-    * @param bool $highlighted
-    * @return Mailcode_Renderer
-    */
+    /**
+     * Sets whether to output highlighted commands instead of the default plain text.
+     * 
+     * @param bool $highlighted
+     * @return Mailcode_Renderer
+     */
     public function setOutputHighlighted(bool $highlighted=true) : Mailcode_Renderer
     {
         $this->highlighted = $highlighted;
@@ -39,12 +39,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts a show variable command to string.
-    * 
-    * @param string $variableName The variable name, with or without $ sign.
-    * @return string
-    */
+    /**
+     * Converts a show variable command to string.
+     * 
+     * @param string $variableName The variable name, with or without $ sign.
+     * @return string
+     */
     public function showVar(string $variableName) : string
     {
         return $this->command2string(Mailcode_Factory::show()->var($variableName));

src/Mailcode/Translator/Syntax/ApacheVelocity/Contains/StatementBuilder.php

Indentation +22 added lines, -22 removed lines

@@ -176,27 +176,27 @@
      * @return array<string,string>
      * @throws Mailcode_Exception
      */
-     private function parseVarName() : array
-     {
-         $tokens = explode('.', ltrim($this->variable->getFullName(), '$'));
-
-         if(count($tokens) === 2)
-         {
-             return array(
-                 'path' => $tokens[0],
-                 'name' => $tokens[1]
-             );
-         }
-
-         throw new Mailcode_Exception(
-             'Invalid variable name for a list property.',
-             sprintf(
-                 'Exactly 2 parts are required, variable [%s] has [%s].',
-                 $this->variable->getFullName(),
-                 count($tokens)
-             ),
-             self::ERROR_INVALID_LIST_VARIABLE_NAME
-         );
-     }
+        private function parseVarName() : array
+        {
+            $tokens = explode('.', ltrim($this->variable->getFullName(), '$'));
+
+            if(count($tokens) === 2)
+            {
+                return array(
+                    'path' => $tokens[0],
+                    'name' => $tokens[1]
+                );
+            }
+
+            throw new Mailcode_Exception(
+                'Invalid variable name for a list property.',
+                sprintf(
+                    'Exactly 2 parts are required, variable [%s] has [%s].',
+                    $this->variable->getFullName(),
+                    count($tokens)
+                ),
+                self::ERROR_INVALID_LIST_VARIABLE_NAME
+            );
+        }
 }
 

src/Mailcode.php

Indentation +45 added lines, -45 removed lines

@@ -26,51 +26,51 @@ 
  */
 class Mailcode
 {
-   /**
-    * @var Mailcode_Parser|NULL
-    */
+    /**
+     * @var Mailcode_Parser|NULL
+     */
     protected $parser = null;
     
-   /**
-    * @var Mailcode_Commands|NULL
-    */
+    /**
+     * @var Mailcode_Commands|NULL
+     */
     protected $commands = null;
     
-   /**
-    * @var Mailcode_Variables|NULL
-    */
+    /**
+     * @var Mailcode_Variables|NULL
+     */
     protected $variables = null;
     
-   /**
-    * @var Mailcode_Translator|NULL
-    */
+    /**
+     * @var Mailcode_Translator|NULL
+     */
     protected $translator = null;
     
-   /**
-    * Creates a new mailcode instance.
-    * @return Mailcode
-    */
+    /**
+     * Creates a new mailcode instance.
+     * @return Mailcode
+     */
     public static function create() : Mailcode
     {
         return new Mailcode();
     }
     
-   /**
-    * Parses the string to detect all commands contained within.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection
-    */
+    /**
+     * Parses the string to detect all commands contained within.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         return $this->getParser()->parseString($string);
     }
     
-   /**
-    * Retrieves the string parser instance used to detect commands.
-    * 
-    * @return Mailcode_Parser
-    */
+    /**
+     * Retrieves the string parser instance used to detect commands.
+     * 
+     * @return Mailcode_Parser
+     */
     public function getParser() : Mailcode_Parser
     {
         if(!isset($this->parser)) 
@@ -81,12 +81,12 @@ 
         return $this->parser;
     }
     
-   /**
-    * Retrieves the commands collection, which is used to
-    * access information on the available commands.
-    * 
-    * @return Mailcode_Commands
-    */
+    /**
+     * Retrieves the commands collection, which is used to
+     * access information on the available commands.
+     * 
+     * @return Mailcode_Commands
+     */
     public function getCommands() : Mailcode_Commands
     {
         if(!isset($this->commands)) 
@@ -129,12 +129,12 @@ 
         return $this->variables;
     }
     
-   /**
-    * Creates the translator, which can be used to convert commands
-    * to another supported syntax.
-    * 
-    * @return Mailcode_Translator
-    */
+    /**
+     * Creates the translator, which can be used to convert commands
+     * to another supported syntax.
+     * 
+     * @return Mailcode_Translator
+     */
     public function createTranslator() : Mailcode_Translator
     {
         if(!isset($this->translator))
@@ -145,12 +145,12 @@ 
         return $this->translator;
     }
     
-   /**
-    * Creates the styler, which can be used to retrieve the 
-    * CSS required to style the highlighted commands in HTML.
-    * 
-    * @return Mailcode_Styler
-    */
+    /**
+     * Creates the styler, which can be used to retrieve the 
+     * CSS required to style the highlighted commands in HTML.
+     * 
+     * @return Mailcode_Styler
+     */
     public function createStyler() : Mailcode_Styler
     {
         return new Mailcode_Styler();

src/Mailcode/Variables/Collection.php

Indentation +56 added lines, -56 removed lines

@@ -20,9 +20,9 @@ 
  */
 abstract class Mailcode_Variables_Collection
 {
-   /**
-    * @var Mailcode_Variables_Variable[]
-    */
+    /**
+     * @var Mailcode_Variables_Variable[]
+     */
     protected $variables = array();
     
     public function __construct()
@@ -52,12 +52,12 @@ 
         return count($this->variables);
     }
     
-   /**
-    * Checks whether the collection contains a variable with the specified name.
-    * 
-    * @param string $fullName The variable name, with or without $ sign.
-    * @return bool
-    */
+    /**
+     * Checks whether the collection contains a variable with the specified name.
+     * 
+     * @param string $fullName The variable name, with or without $ sign.
+     * @return bool
+     */
     public function hasVariableName(string $fullName) : bool
     {
         $fullName = $this->fixName($fullName);
@@ -73,14 +73,14 @@ 
         return false;
     }
     
-   /**
-    * Retrieves a collection of all variable instances for
-    * the specified name (there can be several with differing
-    * matched texts because of spacing).
-    * 
-    * @param string $fullName
-    * @return Mailcode_Variables_Collection
-    */
+    /**
+     * Retrieves a collection of all variable instances for
+     * the specified name (there can be several with differing
+     * matched texts because of spacing).
+     * 
+     * @param string $fullName
+     * @return Mailcode_Variables_Collection
+     */
     public function getByFullName(string $fullName) : Mailcode_Variables_Collection
     {
         $fullName = $this->fixName($fullName);
@@ -98,12 +98,12 @@ 
         return $collection;
     }
     
-   /**
-    * Prepends the $ sign to a variable name if it does not have it.
-    * 
-    * @param string $fullName
-    * @return string
-    */
+    /**
+     * Prepends the $ sign to a variable name if it does not have it.
+     * 
+     * @param string $fullName
+     * @return string
+     */
     protected function fixName(string $fullName) : string
     {
         if(substr($fullName, 0, 1) === '$')
@@ -114,12 +114,12 @@ 
         return '$'.$fullName;
     }
     
-   /**
-    * Retrieves all variables, grouped by their hash - meaning
-    * unique matched strings.
-    * 
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, grouped by their hash - meaning
+     * unique matched strings.
+     * 
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getGroupedByHash() : array
     {
         $entries = array();
@@ -132,11 +132,11 @@ 
         return $this->sortVariables($entries);
     }
     
-   /**
-    * Retrieves all variables, grouped by their name. 
-    * 
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, grouped by their name. 
+     * 
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getGroupedByName() : array
     {
         $entries = array();
@@ -168,19 +168,19 @@ 
         return $this->sortVariables($entries);
     }
     
-   /**
-    * Retrieves all variables, in the order they were addded.
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Retrieves all variables, in the order they were addded.
+     * @return Mailcode_Variables_Variable[]
+     */
     public function getAll()
     {
         return $this->variables;
     }
     
-   /**
-    * Retrieves the full names of the variables that are present in the collection.
-    * @return string[]
-    */
+    /**
+     * Retrieves the full names of the variables that are present in the collection.
+     * @return string[]
+     */
     public function getNames() : array
     {
         $result = array();
@@ -198,13 +198,13 @@ 
         return $result;
     }
     
-   /**
-    * Takes a list of variables and sorts them, throwing away
-    * the source array's keys.
-    * 
-    * @param Mailcode_Variables_Variable[] $entries
-    * @return Mailcode_Variables_Variable[]
-    */
+    /**
+     * Takes a list of variables and sorts them, throwing away
+     * the source array's keys.
+     * 
+     * @param Mailcode_Variables_Variable[] $entries
+     * @return Mailcode_Variables_Variable[]
+     */
     protected function sortVariables(array $entries)
     {
         $result = array_values($entries);
@@ -217,13 +217,13 @@ 
         return $result;
     }
 
-   /**
-    *  Merges the variables collection with the target collection
-    *  by inheriting all that collection's variables.
-    *  
-    * @param Mailcode_Variables_Collection $collection
-    * @return Mailcode_Variables_Collection
-    */
+    /**
+     *  Merges the variables collection with the target collection
+     *  by inheriting all that collection's variables.
+     *  
+     * @param Mailcode_Variables_Collection $collection
+     * @return Mailcode_Variables_Collection
+     */
     public function mergeWith(Mailcode_Variables_Collection $collection) : Mailcode_Variables_Collection
     {
         $variables = $collection->getGroupedByHash();

src/Mailcode/Parser/Statement/Tokenizer/Token.php

Indentation +17 added lines, -17 removed lines

@@ -20,19 +20,19 @@ 
  */
 abstract class Mailcode_Parser_Statement_Tokenizer_Token implements Mailcode_Parser_Statement_Tokenizer_TypeInterface
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $tokenID;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $matchedText;
     
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $subject;
 
     /**
@@ -62,20 +62,20 @@ 
         return $this->sourceCommand;
     }
     
-   /**
-    * The ID of the type. i.e. the class name ("Keyword", "StringLiteral").
-    * @return string
-    */
+    /**
+     * The ID of the type. i.e. the class name ("Keyword", "StringLiteral").
+     * @return string
+     */
     public function getTypeID() : string
     {
         $parts = explode('_', get_class($this));
         return array_pop($parts);
     }
     
-   /**
-    * Retrieves a unique ID of the token.
-    * @return string  
-    */
+    /**
+     * Retrieves a unique ID of the token.
+     * @return string  
+     */
     public function getID() : string
     {
         return $this->tokenID;

src/Mailcode/Parser/Statement/Tokenizer.php

Indentation +32 added lines, -32 removed lines

@@ -38,14 +38,14 @@ 
         'ExtractTokens'
     );
     
-   /**
-    * @var Mailcode_Parser_Statement
-    */
+    /**
+     * @var Mailcode_Parser_Statement
+     */
     protected $statement;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $tokenized;
     
     /**
@@ -53,9 +53,9 @@ 
      */
     protected $tokensOrdered = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $ids = array();
 
     /**
@@ -75,12 +75,12 @@ 
         return $this->statement->getSourceCommand();
     }
 
-   /**
-    * Retrieves all tokens detected in the statement string, in 
-    * the order they were found.
-    * 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token[]
-    */
+    /**
+     * Retrieves all tokens detected in the statement string, in 
+     * the order they were found.
+     * 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token[]
+     */
     public function getTokens()
     {
         return $this->tokensOrdered;
@@ -91,11 +91,11 @@ 
         return !empty($this->tokensOrdered);
     }
     
-   /**
-    * Whether there were any unknown tokens in the statement.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether there were any unknown tokens in the statement.
+     * 
+     * @return bool
+     */
     public function hasUnknown() : bool
     {
         $unknown = $this->getUnknown();
@@ -103,11 +103,11 @@ 
         return !empty($unknown);
     }
     
-   /**
-    * Retrieves all unknown content tokens, if any.
-    * 
-    * @return Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
-    */
+    /**
+     * Retrieves all unknown content tokens, if any.
+     * 
+     * @return Mailcode_Parser_Statement_Tokenizer_Token_Unknown[]
+     */
     public function getUnknown()
     {
         $result = array();
@@ -278,13 +278,13 @@ 
         return $token;
     }
     
-   /**
-    * Generates a unique alphabet-based ID without numbers
-    * to use as token name, to avoid conflicts with the
-    * numbers detection.
-    *
-    * @return string
-    */
+    /**
+     * Generates a unique alphabet-based ID without numbers
+     * to use as token name, to avoid conflicts with the
+     * numbers detection.
+     *
+     * @return string
+     */
     protected function generateID() : string
     {
         static $alphas;

src/Mailcode/Parser.php

Indentation +43 added lines, -43 removed lines

@@ -30,14 +30,14 @@ 
         '{\s*([a-z]+)\s+([a-z-]+)\s*:([^}]*)}'
     );
     
-   /**
-    * @var Mailcode
-    */
+    /**
+     * @var Mailcode
+     */
     protected $mailcode;
     
-   /**
-    * @var Mailcode_Commands
-    */
+    /**
+     * @var Mailcode_Commands
+     */
     protected $commands;
 
     /**
@@ -51,24 +51,24 @@ 
         $this->commands = $this->mailcode->getCommands();
     }
     
-   /**
-    * Gets the regex format string used to detect commands.
-    * 
-    * @return string
-    */
+    /**
+     * Gets the regex format string used to detect commands.
+     * 
+     * @return string
+     */
     protected static function getRegex() : string
     {
         return '/'.implode('|', self::COMMAND_REGEX_PARTS).'/sixU';
     }
     
-   /**
-    * Parses a string to detect all commands within. Returns a
-    * collection instance that contains information on all the 
-    * commands.
-    * 
-    * @param string $string
-    * @return Mailcode_Collection A collection with all unique commands found.
-    */
+    /**
+     * Parses a string to detect all commands within. Returns a
+     * collection instance that contains information on all the 
+     * commands.
+     * 
+     * @param string $string
+     * @return Mailcode_Collection A collection with all unique commands found.
+     */
     public function parseString(string $string) : Mailcode_Collection
     {
         $collection = new Mailcode_Collection();
@@ -103,14 +103,14 @@ 
         return preg_replace('%<style\b[^>]*>(.*?)</style>%six', '', $subject);
     }
     
-   /**
-    * Processes a single match found in the string: creates the command,
-    * and adds it to the collection if it's a valid command, or to the list
-    * of invalid commands otherwise.
-    * 
-    * @param Mailcode_Parser_Match $match
-    * @param Mailcode_Collection $collection
-    */
+    /**
+     * Processes a single match found in the string: creates the command,
+     * and adds it to the collection if it's a valid command, or to the list
+     * of invalid commands otherwise.
+     * 
+     * @param Mailcode_Parser_Match $match
+     * @param Mailcode_Collection $collection
+     */
     protected function processMatch(Mailcode_Parser_Match $match, Mailcode_Collection $collection) : void
     {
         $name = $match->getName();
@@ -173,14 +173,14 @@ 
         throw new Mailcode_Exception('Not a command', '', self::ERROR_NOT_A_COMMAND);
     }
     
-   /**
-    * Parses a single regex match: determines which named group
-    * matches, and retrieves the according information.
-    * 
-    * @param array[] $matches The regex results array.
-    * @param int $index The matched index.
-    * @return Mailcode_Parser_Match
-    */
+    /**
+     * Parses a single regex match: determines which named group
+     * matches, and retrieves the according information.
+     * 
+     * @param array[] $matches The regex results array.
+     * @param int $index The matched index.
+     * @return Mailcode_Parser_Match
+     */
     protected function parseMatch(array $matches, int $index) : Mailcode_Parser_Match
     {
         $name = ''; // the command name, e.g. "showvar"
@@ -218,14 +218,14 @@ 
         );
     }
     
-   /**
-    * Creates an instance of the safeguard tool, which
-    * is used to safeguard commands in a string with placeholders.
-    * 
-    * @param string $subject The string to use to safeguard commands in.
-    * @return Mailcode_Parser_Safeguard
-    * @see Mailcode_Parser_Safeguard
-    */
+    /**
+     * Creates an instance of the safeguard tool, which
+     * is used to safeguard commands in a string with placeholders.
+     * 
+     * @param string $subject The string to use to safeguard commands in.
+     * @return Mailcode_Parser_Safeguard
+     * @see Mailcode_Parser_Safeguard
+     */
     public function createSafeguard(string $subject) : Mailcode_Parser_Safeguard
     {
         return new Mailcode_Parser_Safeguard($this, $subject);