From 0375f48358a9affa4f14dd020a1f81b60139f175 Mon Sep 17 00:00:00 2001
From: grosroro <grosroro@neutron>
Date: Wed, 30 May 2012 18:44:09 +0200
Subject: [PATCH] Add doc blocks

---
 src/FFMpeg/FFMpeg.php           |  4 ++++
 src/FFMpeg/Format/Dimension.php | 19 +++++++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/src/FFMpeg/FFMpeg.php b/src/FFMpeg/FFMpeg.php
index 23001fd..b56b768 100644
--- a/src/FFMpeg/FFMpeg.php
+++ b/src/FFMpeg/FFMpeg.php
@@ -33,6 +33,9 @@ class FFMpeg extends Binary
      */
     protected $prober;
 
+    /**
+     * Destructor
+     */
     public function __destruct()
     {
         $this->prober = null;
@@ -88,6 +91,7 @@ class FFMpeg extends Binary
     }
 
     /**
+     * Extract an image from a media file
      *
      * @param  integer          $time   The time in second where to take the snapshot
      * @param  string           $output The pathfile where to write
diff --git a/src/FFMpeg/Format/Dimension.php b/src/FFMpeg/Format/Dimension.php
index 1907b3a..cdec4e5 100644
--- a/src/FFMpeg/Format/Dimension.php
+++ b/src/FFMpeg/Format/Dimension.php
@@ -14,6 +14,8 @@ namespace FFMpeg\Format;
 use FFMpeg\Exception\InvalidArgumentException;
 
 /**
+ * Dimension object, used for manipulating width and height couples
+ * 
  * @author Romain Neutron imprec@gmail.com
  */
 class Dimension
@@ -21,6 +23,13 @@ class Dimension
     protected $width;
     protected $height;
 
+    /**
+     * Constructor
+     * 
+     * @param  integer $width
+     * @param  integer $height
+     * @throws InvalidArgumentException when one of the parameteres is invalid
+     */
     public function __construct($width, $height)
     {
         if ($width <= 0 || $height <= 0) {
@@ -31,11 +40,21 @@ class Dimension
         $this->height = (int) $height;
     }
 
+    /**
+     * Return width
+     * 
+     * @return width
+     */
     public function getWidth()
     {
         return $this->width;
     }
 
+    /**
+     * Return height
+     * 
+     * @return integer
+     */
     public function getHeight()
     {
         return $this->height;