Add API documentation

Author: sebastianbergmann

src/Chunk.php

@@ -54,12 +54,37 @@
  */
 class Chunk
 {
+    /**
+     * @var int
+     */
     private $start;
+
+    /**
+     * @var int
+     */
     private $startRange;
+
+    /**
+     * @var int
+     */
     private $end;
+    /**
+     * @var int
+     */
     private $endRange;
+
+    /**
+     * @var array
+     */
     private $lines;
 
+    /**
+     * @param int   $start
+     * @param int   $startRange
+     * @param int   $end
+     * @param int   $endRange
+     * @param array $lines
+     */
     public function __construct($start = 0, $startRange = 1, $end = 0, $endRange = 1, array $lines = array())
     {
         $this->start      = (int) $start;
@@ -69,31 +94,49 @@ public function __construct($start = 0, $startRange = 1, $end = 0, $endRange = 1
         $this->lines      = $lines;
     }
 
+    /**
+     * @return int
+     */
     public function getStart()
     {
         return $this->start;
     }
 
+    /**
+     * @return int
+     */
     public function getStartRange()
     {
         return $this->startRange;
     }
 
+    /**
+     * @return int
+     */
     public function getEnd()
     {
         return $this->end;
     }
 
+    /**
+     * @return int
+     */
     public function getEndRange()
     {
         return $this->endRange;
     }
 
+    /**
+     * @return array
+     */
     public function getLines()
     {
         return $this->lines;
     }
 
+    /**
+     * @param array $lines
+     */
     public function setLines(array $lines)
     {
         $this->lines = $lines;

src/Diff.php

@@ -54,32 +54,60 @@
  */
 class Diff
 {
+    /**
+     * @var string
+     */
     private $from;
+
+    /**
+     * @var string
+     */
     private $to;
+
+    /**
+     * @var Chunk[]
+     */
     private $chunks;
 
+    /**
+     * @param string  $from
+     * @param string  $to
+     * @param Chunk[] $chunks
+     */
     public function __construct($from, $to, array $chunks = array())
     {
         $this->from   = $from;
         $this->to     = $to;
         $this->chunks = $chunks;
     }
 
+    /**
+     * @return string
+     */
     public function getFrom()
     {
         return $this->from;
     }
 
+    /**
+     * @return string
+     */
     public function getTo()
     {
         return $this->to;
     }
 
+    /**
+     * @return Chunk[]
+     */
     public function getChunks()
     {
         return $this->chunks;
     }
 
+    /**
+     * @param Chunk[] $chunks
+     */
     public function setChunks(array $chunks)
     {
         $this->chunks = $chunks;

src/Line.php

@@ -58,20 +58,37 @@ class Line
     const REMOVED = 2;
     const UNCHANGED = 3;
 
+    /**
+     * @var int
+     */
     private $type;
+
+    /**
+     * @var string
+     */
     private $content;
 
+    /**
+     * @param int    $type
+     * @param string $content
+     */
     public function __construct($type = self::UNCHANGED, $content = null)
     {
         $this->type    = $type;
         $this->content = $content;
     }
 
+    /**
+     * @return string
+     */
     public function getContent()
     {
         return $this->content;
     }
 
+    /**
+     * @return int
+     */
     public function getType()
     {
         return $this->type;

src/Parser.php

@@ -56,6 +56,10 @@
  */
 class Parser
 {
+    /**
+     * @param  string $string
+     * @return Diff[]
+     */
     public function parse($string)
     {
         $lines     = preg_split('(\r\n|\r|\n)', $string);
@@ -88,6 +92,10 @@ public function parse($string)
         return $diffs;
     }
 
+    /**
+     * @param Diff  $diff
+     * @param array $lines
+     */
     private function parseFileDiff(Diff $diff, array $lines)
     {
         $chunks = array();