Add doc blocks
This commit is contained in:
		
					parent
					
						
							
								0ceef488e3
							
						
					
				
			
			
				commit
				
					
						0375f48358
					
				
			
		
					 2 changed files with 23 additions and 0 deletions
				
			
		|  | @ -33,6 +33,9 @@ class FFMpeg extends Binary | ||||||
|      */ |      */ | ||||||
|     protected $prober; |     protected $prober; | ||||||
| 
 | 
 | ||||||
|  |     /** | ||||||
|  |      * Destructor | ||||||
|  |      */ | ||||||
|     public function __destruct() |     public function __destruct() | ||||||
|     { |     { | ||||||
|         $this->prober = null; |         $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  integer          $time   The time in second where to take the snapshot | ||||||
|      * @param  string           $output The pathfile where to write |      * @param  string           $output The pathfile where to write | ||||||
|  |  | ||||||
|  | @ -14,6 +14,8 @@ namespace FFMpeg\Format; | ||||||
| use FFMpeg\Exception\InvalidArgumentException; | use FFMpeg\Exception\InvalidArgumentException; | ||||||
| 
 | 
 | ||||||
| /** | /** | ||||||
|  |  * Dimension object, used for manipulating width and height couples | ||||||
|  |  *  | ||||||
|  * @author Romain Neutron imprec@gmail.com |  * @author Romain Neutron imprec@gmail.com | ||||||
|  */ |  */ | ||||||
| class Dimension | class Dimension | ||||||
|  | @ -21,6 +23,13 @@ class Dimension | ||||||
|     protected $width; |     protected $width; | ||||||
|     protected $height; |     protected $height; | ||||||
| 
 | 
 | ||||||
|  |     /** | ||||||
|  |      * Constructor | ||||||
|  |      *  | ||||||
|  |      * @param  integer $width | ||||||
|  |      * @param  integer $height | ||||||
|  |      * @throws InvalidArgumentException when one of the parameteres is invalid | ||||||
|  |      */ | ||||||
|     public function __construct($width, $height) |     public function __construct($width, $height) | ||||||
|     { |     { | ||||||
|         if ($width <= 0 || $height <= 0) { |         if ($width <= 0 || $height <= 0) { | ||||||
|  | @ -31,11 +40,21 @@ class Dimension | ||||||
|         $this->height = (int) $height; |         $this->height = (int) $height; | ||||||
|     } |     } | ||||||
| 
 | 
 | ||||||
|  |     /** | ||||||
|  |      * Return width | ||||||
|  |      *  | ||||||
|  |      * @return width | ||||||
|  |      */ | ||||||
|     public function getWidth() |     public function getWidth() | ||||||
|     { |     { | ||||||
|         return $this->width; |         return $this->width; | ||||||
|     } |     } | ||||||
| 
 | 
 | ||||||
|  |     /** | ||||||
|  |      * Return height | ||||||
|  |      *  | ||||||
|  |      * @return integer | ||||||
|  |      */ | ||||||
|     public function getHeight() |     public function getHeight() | ||||||
|     { |     { | ||||||
|         return $this->height; |         return $this->height; | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue