Adding documentation uri's

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

Hide file tree

Showing 44 changed files with 223 additions and 12 deletions.
diff --git a/lib/Tmdb/Api/Account.php b/lib/Tmdb/Api/Account.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Account
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#account
+ */
 class Account
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Authentication.php b/lib/Tmdb/Api/Authentication.php
@@ -13,9 +13,13 @@
 namespace Tmdb\Api;
 
 use Symfony\Component\Yaml\Exception\RuntimeException;
-use Tmdb\Exception\NotImplementedException;
 use Tmdb\Exception\UnauthorizedRequestTokenException;
 
+/**
+ * Class Authentication
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#authentication
+ */
 class Authentication
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Certifications.php b/lib/Tmdb/Api/Certifications.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Certifications
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#certifications
+ */
 class Certifications
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Changes.php b/lib/Tmdb/Api/Changes.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Changes
+ * @package Tmdb\Api
+ * http://docs.themoviedb.apiary.io/#changes
+ */
 class Changes
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Collections.php b/lib/Tmdb/Api/Collections.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Collections
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#collections
+ */
 class Collections
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Companies.php b/lib/Tmdb/Api/Companies.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Companies
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#companies
+ */
 class Companies
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Configuration.php b/lib/Tmdb/Api/Configuration.php
@@ -12,6 +12,12 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Configuration
+ * @package Tmdb\Api
+ *
+ * @see http://docs.themoviedb.apiary.io/#configuration
+ */
 class Configuration
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Credits.php b/lib/Tmdb/Api/Credits.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Credits
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#credits
+ */
 class Credits
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Discover.php b/lib/Tmdb/Api/Discover.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Discover
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#discover
+ */
 class Discover
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Find.php b/lib/Tmdb/Api/Find.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Find
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#find
+ */
 class Find
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Genres.php b/lib/Tmdb/Api/Genres.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Genres
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#genres
+ */
 class Genres
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Jobs.php b/lib/Tmdb/Api/Jobs.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Jobs
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#jobs
+ */
 class Jobs
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Keywords.php b/lib/Tmdb/Api/Keywords.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Keywords
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#keywords
+ */
 class Keywords
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Lists.php b/lib/Tmdb/Api/Lists.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Lists
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#lists
+ */
 class Lists
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Movies.php b/lib/Tmdb/Api/Movies.php
@@ -12,8 +12,11 @@
  */
 namespace Tmdb\Api;
 
-use Tmdb\Exception\NotImplementedException;
-
+/**
+ * Class Movies
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#movies
+ */
 class Movies
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Networks.php b/lib/Tmdb/Api/Networks.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Networks
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#networks
+ */
 class Networks
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/People.php b/lib/Tmdb/Api/People.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class People
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#people
+ */
 class People
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Reviews.php b/lib/Tmdb/Api/Reviews.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Reviews
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#reviews
+ */
 class Reviews
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Search.php b/lib/Tmdb/Api/Search.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Search
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#search
+ */
 class Search
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/Tv.php b/lib/Tmdb/Api/Tv.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class Tv
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#tv
+ */
 class Tv
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/TvEpisode.php b/lib/Tmdb/Api/TvEpisode.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class TvEpisode
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#tvepisodes
+ */
 class TvEpisode
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Api/TvSeason.php b/lib/Tmdb/Api/TvSeason.php
@@ -12,6 +12,11 @@
  */
 namespace Tmdb\Api;
 
+/**
+ * Class TvSeason
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#tvseasons
+ */
 class TvSeason
     extends AbstractApi
 {

diff --git a/lib/Tmdb/Repository/AccountRepository.php b/lib/Tmdb/Repository/AccountRepository.php
@@ -16,6 +16,11 @@
 use Tmdb\Model\Collection\ResultCollection;
 use Tmdb\Model\Movie;
 
+/**
+ * Class AccountRepository
+ * @package Tmdb\Repository
+ * http://docs.themoviedb.apiary.io/#account
+ */
 class AccountRepository extends AbstractRepository {
 
     /**

diff --git a/lib/Tmdb/Repository/AuthenticationRepository.php b/lib/Tmdb/Repository/AuthenticationRepository.php
@@ -15,6 +15,11 @@
 use Tmdb\Factory\AuthenticationFactory;
 use Tmdb\RequestToken;
 
+/**
+ * Class AuthenticationRepository
+ * @package Tmdb\Repository
+ * @see http://docs.themoviedb.apiary.io/#authentication
+ */
 class AuthenticationRepository extends AbstractRepository {
 
     /**

diff --git a/lib/Tmdb/Repository/CertificationRepository.php b/lib/Tmdb/Repository/CertificationRepository.php
@@ -15,6 +15,11 @@
 use Tmdb\Factory\CertificationFactory;
 use Tmdb\Model\Collection as ApiCollection;
 
+/**
+ * Class CertificationRepository
+ * @package Tmdb\Repository
+ * @see http://docs.themoviedb.apiary.io/#certifications
+ */
 class CertificationRepository extends AbstractRepository {
 
     /**

diff --git a/lib/Tmdb/Repository/ChangesRepository.php b/lib/Tmdb/Repository/ChangesRepository.php
@@ -16,6 +16,11 @@
 use Tmdb\Model\Collection\People;
 use Tmdb\Model\Query\ChangesQuery;
 
+/**
+ * Class ChangesRepository
+ * @package Tmdb\Repository
+ * @see http://docs.themoviedb.apiary.io/#changes
+ */
 class ChangesRepository extends AbstractRepository {
     /**
      * Get a list of movie ids that have been edited.

diff --git a/lib/Tmdb/Repository/CollectionRepository.php b/lib/Tmdb/Repository/CollectionRepository.php
@@ -16,9 +16,13 @@
 use Tmdb\Factory\CollectionFactory;
 use Tmdb\Factory\ImageFactory;
 use Tmdb\Model\Collection as ApiCollection;
+use Tmdb\Model\Collection\QueryParameter\AppendToResponse;
 
-use \Tmdb\Model\Collection\QueryParameter\AppendToResponse;
-
+/**
+ * Class CollectionRepository
+ * @package Tmdb\Repository
+ * @see http://docs.themoviedb.apiary.io/#collections
+ */
 class CollectionRepository extends AbstractRepository {
 
     private $imageFactory;

diff --git a/lib/Tmdb/Repository/CompanyRepository.php b/lib/Tmdb/Repository/CompanyRepository.php
@@ -18,6 +18,11 @@
 use Tmdb\Model\Company;
 use Tmdb\Model\Movie;
 
+/**
+ * Class CompanyRepository
+ * @package Tmdb\Repository
+ * @see http://docs.themoviedb.apiary.io/#movies
+ */
 class CompanyRepository extends AbstractRepository {
 
     /**

diff --git a/lib/Tmdb/Repository/ConfigurationRepository.php b/lib/Tmdb/Repository/ConfigurationRepository.php
@@ -15,6 +15,11 @@
 use Tmdb\Factory\ConfigurationFactory;
 use Tmdb\Model\Configuration;
 
+/**
+ * Class ConfigurationRepository
+ * @package Tmdb\Repository
+ * @see http://docs.themoviedb.apiary.io/#configuration
+ */
 class ConfigurationRepository extends AbstractRepository {
 
     /**

diff --git a/lib/Tmdb/Repository/CreditsRepository.php b/lib/Tmdb/Repository/CreditsRepository.php
@@ -17,6 +17,11 @@
 use Tmdb\Model\Company;
 use Tmdb\Model\Movie;
 
+/**
+ * Class CreditsRepository
+ * @package Tmdb\Repository
+ * @see http://docs.themoviedb.apiary.io/#credits
+ */
 class CreditsRepository extends AbstractRepository {
 
     /**

diff --git a/lib/Tmdb/Repository/DiscoverRepository.php b/lib/Tmdb/Repository/DiscoverRepository.php
@@ -21,6 +21,11 @@
 use Tmdb\Model\Query\Discover\DiscoverTvQuery;
 use Tmdb\Model\Tv;
 
+/**
+ * Class DiscoverRepository
+ * @package Tmdb\Repository
+ * @see http://docs.themoviedb.apiary.io/#discover
+ */
 class DiscoverRepository extends AbstractRepository {
     /**
      * Discover movies by different types of data like average rating, number of votes, genres and certifications.

diff --git a/lib/Tmdb/Repository/FindRepository.php b/lib/Tmdb/Repository/FindRepository.php
@@ -12,10 +12,14 @@
  */
 namespace Tmdb\Repository;
 
-// @todo
 use Tmdb\Factory\FindFactory;
 use Tmdb\Model\Find;
 
+/**
+ * Class FindRepository
+ * @package Tmdb\Repository
+ * @see http://docs.themoviedb.apiary.io/#find
+ */
 class FindRepository extends AbstractRepository {
     /**
      * Find something