Missing phpdoc @throws annotation

soluble-io · Mar 19, 2019 · 50d23c5 · 50d23c5
1 parent 5c9d072
commit 50d23c5
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) 
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.0.2 (2019-03-19)
+
+### Improved
+
+- Stream collections now properly document 'NoStreamException'.  
+- Improved documentation for VideoInfoReader.
+
 ## 2.0.1 (2019-03-15)
 
 ### Improved

diff --git a/src/Video/Info/AudioStreamCollection.php b/src/Video/Info/AudioStreamCollection.php
@@ -26,6 +26,9 @@ public function __construct(array $audioStreamsMetadata)
         $this->loadStreams();
     }
 
+    /**
+     * @throws NoStreamException
+     */
     public function getFirst(): AudioStreamInterface
     {
         if ($this->count() === 0) {

diff --git a/src/Video/Info/AudioStreamCollectionInterface.php b/src/Video/Info/AudioStreamCollectionInterface.php
@@ -4,7 +4,12 @@
 
 namespace Soluble\MediaTools\Video\Info;
 
+use Soluble\MediaTools\Video\Exception\NoStreamException;
+
 interface AudioStreamCollectionInterface extends StreamCollectionInterface
 {
+    /**
+     * @throws NoStreamException
+     */
     public function getFirst(): AudioStreamInterface;
 }
diff --git a/src/Video/Info/SubtitleStreamCollection.php b/src/Video/Info/SubtitleStreamCollection.php
@@ -26,6 +26,9 @@ public function __construct(array $subtitleStreamsMetadata)
         $this->loadStreams();
     }
 
+    /**
+     * @throws NoStreamException
+     */
     public function getFirst(): SubtitleStreamInterface
     {
         if ($this->count() === 0) {

diff --git a/src/Video/Info/SubtitleStreamCollectionInterface.php b/src/Video/Info/SubtitleStreamCollectionInterface.php
@@ -4,7 +4,12 @@
 
 namespace Soluble\MediaTools\Video\Info;
 
+use Soluble\MediaTools\Video\Exception\NoStreamException;
+
 interface SubtitleStreamCollectionInterface extends StreamCollectionInterface
 {
+    /**
+     * @throws NoStreamException
+     */
     public function getFirst(): SubtitleStreamInterface;
 }
diff --git a/src/Video/Info/VideoStreamCollection.php b/src/Video/Info/VideoStreamCollection.php
@@ -34,6 +34,9 @@ public function __construct(array $videoStreamsMetadata, ?LoggerInterface $logge
         $this->loadStreams();
     }
 
+    /**
+     * @throws NoStreamException
+     */
     public function getFirst(): VideoStreamInterface
     {
         if ($this->count() === 0) {

diff --git a/src/Video/Info/VideoStreamCollectionInterface.php b/src/Video/Info/VideoStreamCollectionInterface.php
@@ -4,7 +4,12 @@
 
 namespace Soluble\MediaTools\Video\Info;
 
+use Soluble\MediaTools\Video\Exception\NoStreamException;
+
 interface VideoStreamCollectionInterface extends StreamCollectionInterface
 {
+    /**
+     * @throws NoStreamException
+     */
     public function getFirst(): VideoStreamInterface;
 }