Added comment to DiffFormatter _escape() method

Clarify use of _escape() method in base class.

1 files changed, 10 insertions, 1 deletions

diff --git a/inc/DifferenceEngine.php b/inc/DifferenceEngine.php
index 783d6bea5..07df7a4be 100644
--- a/inc/DifferenceEngine.php
+++ b/inc/DifferenceEngine.php
@@ -817,7 +817,16 @@ class DiffFormatter {
         $this->_added($closing);
     }
 
-    function _escape($str){
+    /**
+     * Escape string
+     * 
+     * Override this method within other formatters if escaping required.
+     * Base class requires $str to be returned WITHOUT escaping.
+     * 
+     * @param $str string Text string to escape
+     * @return string The escaped string.
+     */
+     function _escape($str){
         return $str;
     }
 }