caxy / php-htmldiff

lib/Caxy/HtmlDiff/HtmlDiff.php

Doc Comments +36 added lines

@@ -157,6 +157,9 @@ 
         $this->processInsertOperation( $operation, "diffmod" );
     }
 
+    /**
+     * @param string $cssClass
+     */
     protected function processInsertOperation($operation, $cssClass)
     {
         $text = array();
@@ -174,6 +177,9 @@ 
         $this->insertTag( "ins", $cssClass, $text );
     }
 
+    /**
+     * @param string $cssClass
+     */
     protected function processDeleteOperation($operation, $cssClass)
     {
         $text = array();
@@ -213,6 +219,10 @@ 
         return $this->diffElements($oldText, $newText, $stripWrappingTags);
     }
 
+    /**
+     * @param string $oldText
+     * @param string $newText
+     */
     protected function diffElements($oldText, $newText, $stripWrappingTags = true)
     {
         $wrapStart = '';
@@ -235,6 +245,10 @@ 
         return $wrapStart . $diff->build() . $wrapEnd;
     }
 
+    /**
+     * @param string $oldText
+     * @param string $newText
+     */
     protected function diffList($oldText, $newText)
     {
         $diff = new ListDiffNew($oldText, $newText, $this->encoding, $this->specialCaseTags, $this->groupDiffs);
@@ -298,6 +312,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $text
+     */
     protected function isListPlaceholder($text)
     {
         return $this->isPlaceholderType($text, array('ol', 'dl', 'ul'));
@@ -338,6 +355,10 @@ 
         return in_array($text, $criteria, $strict);
     }
 
+    /**
+     * @param Operation $operation
+     * @param integer $posInNew
+     */
     protected function findIsolatedDiffTagsInOld($operation, $posInNew)
     {
         $offset = $posInNew - $operation->startInNew;
@@ -345,6 +366,9 @@ 
         return $this->oldIsolatedDiffTags[$operation->startInOld + $offset];
     }
 
+    /**
+     * @param string $tag
+     */
     protected function insertTag($tag, $cssClass, &$words)
     {
         while (true) {
@@ -406,11 +430,17 @@ 
         return $condition == 'tag' ? $this->isTag( $word ) : !$this->isTag( $word );
     }
 
+    /**
+     * @param string $text
+     */
     protected function wrapText($text, $tagName, $cssClass)
     {
         return sprintf( '<%1$s class="%2$s">%3$s</%1$s>', $tagName, $cssClass, $text );
     }
 
+    /**
+     * @param string $condition
+     */
     protected function extractConsecutiveWords(&$words, $condition)
     {
         $indexOfFirstTag = null;
@@ -503,6 +533,12 @@ 
         return $matchingBlocks;
     }
 
+    /**
+     * @param integer $startInOld
+     * @param integer $endInOld
+     * @param integer $startInNew
+     * @param integer $endInNew
+     */
     protected function findMatchingBlocks($startInOld, $endInOld, $startInNew, $endInNew, &$matchingBlocks)
     {
         $match = $this->findMatch( $startInOld, $endInOld, $startInNew, $endInNew );