Adding docblocks

johannesx75 · Feb 26, 2014 · 2eb61b9 · 2eb61b9
1 parent 411104d
commit 2eb61b9
Show file tree

Hide file tree

Showing 143 changed files with 569 additions and 11 deletions.
diff --git a/lib/Tmdb/Api/AbstractApi.php b/lib/Tmdb/Api/AbstractApi.php
@@ -15,6 +15,10 @@
 use Guzzle\Http\Message\Response;
 use Tmdb\Client;
 
+/**
+ * Class AbstractApi
+ * @package Tmdb\Api
+ */
 abstract class AbstractApi
     implements ApiInterface
 {

diff --git a/lib/Tmdb/Api/ApiInterface.php b/lib/Tmdb/Api/ApiInterface.php
@@ -12,5 +12,9 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Interface ApiInterface
+ * @package Tmdb\Api
+ */
 interface ApiInterface {
 }
diff --git a/lib/Tmdb/ApiToken.php b/lib/Tmdb/ApiToken.php
@@ -12,6 +12,10 @@
  */
 namespace Tmdb;
 
+/**
+ * Class ApiToken
+ * @package Tmdb
+ */
 class ApiToken {
     private $apiToken = null;
 

diff --git a/lib/Tmdb/Client.php b/lib/Tmdb/Client.php
@@ -22,8 +22,7 @@
 use Tmdb\HttpClient\Plugin\SessionTokenPlugin;
 
 /**
- * Simple wrapper for the Tmdb API
- *
+ * Client wrapper for TMDB
  * @package Tmdb
  */
 class Client {

diff --git a/lib/Tmdb/Exception/InvalidArgumentException.php b/lib/Tmdb/Exception/InvalidArgumentException.php
@@ -12,6 +12,10 @@
  */
 namespace Tmdb\Exception;
 
+/**
+ * Class InvalidArgumentException
+ * @package Tmdb\Exception
+ */
 class InvalidArgumentException extends \InvalidArgumentException {
 
 }
diff --git a/lib/Tmdb/Exception/MissingArgumentException.php b/lib/Tmdb/Exception/MissingArgumentException.php
@@ -12,6 +12,10 @@
  */
 namespace Tmdb\Exception;
 
+/**
+ * Class MissingArgumentException
+ * @package Tmdb\Exception
+ */
 class MissingArgumentException extends \InvalidArgumentException {
 
 }
diff --git a/lib/Tmdb/Exception/NotImplementedException.php b/lib/Tmdb/Exception/NotImplementedException.php
@@ -12,6 +12,10 @@
  */
 namespace Tmdb\Exception;
 
+/**
+ * Class NotImplementedException
+ * @package Tmdb\Exception
+ */
 class NotImplementedException extends \Exception {
 
 }
diff --git a/lib/Tmdb/Exception/RuntimeException.php b/lib/Tmdb/Exception/RuntimeException.php
@@ -12,6 +12,10 @@
  */
 namespace Tmdb\Exception;
 
+/**
+ * Class RuntimeException
+ * @package Tmdb\Exception
+ */
 class RuntimeException extends \RuntimeException {
 
 }
diff --git a/lib/Tmdb/Exception/UnauthorizedRequestTokenException.php b/lib/Tmdb/Exception/UnauthorizedRequestTokenException.php
@@ -12,6 +12,10 @@
  */
 namespace Tmdb\Exception;
 
+/**
+ * Class UnauthorizedRequestTokenException
+ * @package Tmdb\Exception
+ */
 class UnauthorizedRequestTokenException extends \RuntimeException {
 
 }
diff --git a/lib/Tmdb/Factory/AbstractFactory.php b/lib/Tmdb/Factory/AbstractFactory.php
@@ -17,6 +17,10 @@
 use Tmdb\Model\Collection\ResultCollection;
 use Tmdb\Model\Common\GenericCollection;
 
+/**
+ * Class AbstractFactory
+ * @package Tmdb\Factory
+ */
 abstract class AbstractFactory implements FactoryInterface {
     /**
      * Convert an array to an hydrated object

diff --git a/lib/Tmdb/Factory/AccountFactory.php b/lib/Tmdb/Factory/AccountFactory.php
@@ -16,6 +16,10 @@
 use Tmdb\Model\Account;
 use Tmdb\Model\Lists\Result;
 
+/**
+ * Class AccountFactory
+ * @package Tmdb\Factory
+ */
 class AccountFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/AuthenticationFactory.php b/lib/Tmdb/Factory/AuthenticationFactory.php
@@ -16,6 +16,10 @@
 use Tmdb\RequestToken;
 use Tmdb\SessionToken;
 
+/**
+ * Class AuthenticationFactory
+ * @package Tmdb\Factory
+ */
 class AuthenticationFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/CertificationFactory.php b/lib/Tmdb/Factory/CertificationFactory.php
@@ -15,6 +15,10 @@
 use Tmdb\Model\Certification;
 use Tmdb\Model\Common\GenericCollection;
 
+/**
+ * Class CertificationFactory
+ * @package Tmdb\Factory
+ */
 class CertificationFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/ChangesFactory.php b/lib/Tmdb/Factory/ChangesFactory.php
@@ -15,6 +15,10 @@
 use Tmdb\Model\Change;
 use Tmdb\Model\Collection\Changes;
 
+/**
+ * Class ChangesFactory
+ * @package Tmdb\Factory
+ */
 class ChangesFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/CollectionFactory.php b/lib/Tmdb/Factory/CollectionFactory.php
@@ -15,6 +15,10 @@
 use Tmdb\Model\Collection;
 use Tmdb\Model\Common\GenericCollection;
 
+/**
+ * Class CollectionFactory
+ * @package Tmdb\Factory
+ */
 class CollectionFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/Common/ChangeFactory.php b/lib/Tmdb/Factory/Common/ChangeFactory.php
@@ -16,6 +16,10 @@
 use Tmdb\Model\Common\Change;
 use Tmdb\Model\Common\GenericCollection;
 
+/**
+ * Class ChangeFactory
+ * @package Tmdb\Factory\Common
+ */
 class ChangeFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/CompanyFactory.php b/lib/Tmdb/Factory/CompanyFactory.php
@@ -14,6 +14,10 @@
 
 use Tmdb\Model\Company;
 
+/**
+ * Class CompanyFactory
+ * @package Tmdb\Factory
+ */
 class CompanyFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/ConfigurationFactory.php b/lib/Tmdb/Factory/ConfigurationFactory.php
@@ -14,6 +14,10 @@
 
 use Tmdb\Model\Configuration;
 
+/**
+ * Class ConfigurationFactory
+ * @package Tmdb\Factory
+ */
 class ConfigurationFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/CreditsFactory.php b/lib/Tmdb/Factory/CreditsFactory.php
@@ -17,6 +17,10 @@
 use Tmdb\Model\Movie;
 use Tmdb\Model\Credits as Credits;
 
+/**
+ * Class CreditsFactory
+ * @package Tmdb\Factory
+ */
 class CreditsFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/FactoryInterface.php b/lib/Tmdb/Factory/FactoryInterface.php
@@ -12,6 +12,10 @@
  */
 namespace Tmdb\Factory;
 
+/**
+ * Interface FactoryInterface
+ * @package Tmdb\Factory
+ */
 interface FactoryInterface {
 
     /**

diff --git a/lib/Tmdb/Factory/FindFactory.php b/lib/Tmdb/Factory/FindFactory.php
@@ -15,6 +15,10 @@
 use Tmdb\Exception\NotImplementedException;
 use Tmdb\Model\Find;
 
+/**
+ * Class FindFactory
+ * @package Tmdb\Factory
+ */
 class FindFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/GenreFactory.php b/lib/Tmdb/Factory/GenreFactory.php
@@ -16,6 +16,10 @@
 use Tmdb\Model\Genre;
 use Tmdb\Model\Movie;
 
+/**
+ * Class GenreFactory
+ * @package Tmdb\Factory
+ */
 class GenreFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/ImageFactory.php b/lib/Tmdb/Factory/ImageFactory.php
@@ -15,6 +15,10 @@
 use Tmdb\Model\Collection\Images;
 use Tmdb\Model\Image;
 
+/**
+ * Class ImageFactory
+ * @package Tmdb\Factory
+ */
 class ImageFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/JobsFactory.php b/lib/Tmdb/Factory/JobsFactory.php
@@ -15,6 +15,10 @@
 use Tmdb\Model\Collection\Jobs;
 use Tmdb\Model\Job;
 
+/**
+ * Class JobsFactory
+ * @package Tmdb\Factory
+ */
 class JobsFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/KeywordFactory.php b/lib/Tmdb/Factory/KeywordFactory.php
@@ -16,6 +16,10 @@
 use Tmdb\Model\Keyword;
 use Tmdb\Model\Movie;
 
+/**
+ * Class KeywordFactory
+ * @package Tmdb\Factory
+ */
 class KeywordFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/ListFactory.php b/lib/Tmdb/Factory/ListFactory.php
@@ -13,12 +13,15 @@
 namespace Tmdb\Factory;
 
 use Tmdb\Factory\Lists\ListItemFactory;
-use Tmdb\Model\Collection\Genres;
 use Tmdb\Model\Common\GenericCollection;
 use Tmdb\Model\Genre;
 use Tmdb\Model\Lists;
 use Tmdb\Model\Movie;
 
+/**
+ * Class ListFactory
+ * @package Tmdb\Factory
+ */
 class ListFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/Lists/ListItemFactory.php b/lib/Tmdb/Factory/Lists/ListItemFactory.php
@@ -17,6 +17,10 @@
 use Tmdb\Model\Common\GenericCollection;
 use Tmdb\Model\Lists\ListItem;
 
+/**
+ * Class ListItemFactory
+ * @package Tmdb\Factory\Lists
+ */
 class ListItemFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/Movie/AlternativeTitleFactory.php b/lib/Tmdb/Factory/Movie/AlternativeTitleFactory.php
@@ -16,6 +16,10 @@
 use Tmdb\Model\Common\GenericCollection;
 use Tmdb\Model\Movie\AlternativeTitle;
 
+/**
+ * Class AlternativeTitleFactory
+ * @package Tmdb\Factory\Movie
+ */
 class AlternativeTitleFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/Movie/ListItemFactory.php b/lib/Tmdb/Factory/Movie/ListItemFactory.php
@@ -14,9 +14,12 @@
 
 use Tmdb\Factory\AbstractFactory;
 use Tmdb\Factory\ImageFactory;
-use Tmdb\Model\Collection\ResultCollection;
 use Tmdb\Model\Movie\ListItem;
 
+/**
+ * Class ListItemFactory
+ * @package Tmdb\Factory\Movie
+ */
 class ListItemFactory extends AbstractFactory
 {
     private $imageFactory;

diff --git a/lib/Tmdb/Factory/MovieFactory.php b/lib/Tmdb/Factory/MovieFactory.php
@@ -14,7 +14,6 @@
 
 use Tmdb\Factory\Common\ChangeFactory;
 use Tmdb\Factory\Movie\ListItemFactory;
-use Tmdb\Factory\ReviewFactory;
 use Tmdb\Factory\People\CastFactory;
 use Tmdb\Factory\People\CrewFactory;
 use Tmdb\Model\Common\GenericCollection;
@@ -23,6 +22,10 @@
 use Tmdb\Model\Lists\Result;
 use Tmdb\Model\Movie;
 
+/**
+ * Class MovieFactory
+ * @package Tmdb\Factory
+ */
 class MovieFactory extends AbstractFactory {
     /**
      * @var People\CastFactory

diff --git a/lib/Tmdb/Factory/NetworkFactory.php b/lib/Tmdb/Factory/NetworkFactory.php
@@ -12,11 +12,14 @@
  */
 namespace Tmdb\Factory;
 
-use Tmdb\Model\Collection\Networks;
 use Tmdb\Model\Common\GenericCollection;
 use Tmdb\Model\Network;
 use Tmdb\Model\Movie;
 
+/**
+ * Class NetworkFactory
+ * @package Tmdb\Factory
+ */
 class NetworkFactory extends AbstractFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/People/CastFactory.php b/lib/Tmdb/Factory/People/CastFactory.php
@@ -15,6 +15,10 @@
 use Tmdb\Factory\PeopleFactory;
 use Tmdb\Model\Collection\People\Cast;
 
+/**
+ * Class CastFactory
+ * @package Tmdb\Factory\People
+ */
 class CastFactory extends PeopleFactory
 {
     /**

diff --git a/lib/Tmdb/Factory/People/CrewFactory.php b/lib/Tmdb/Factory/People/CrewFactory.php
@@ -15,6 +15,10 @@
 use Tmdb\Factory\PeopleFactory;
 use Tmdb\Model\Collection\People\Crew;
 
+/**
+ * Class CrewFactory
+ * @package Tmdb\Factory\People
+ */
 class CrewFactory extends PeopleFactory
 {
     /**