Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Commit

Permalink
style: Spelling correction and 'return' tag in the comments
Browse files Browse the repository at this point in the history
  • Loading branch information
joserick committed Apr 13, 2019
1 parent 61f7866 commit 594bb4e
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions src/Joserick/Plex/Server/Library/SectionAbstract.php
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ abstract class Plex_Server_Library_SectionAbstract extends Plex_Server_Library
protected $title;

/**
* The metadata agent for the sectiion.
* The metadata agent for the section.
* @var string
*/
protected $agent;
Expand Down Expand Up @@ -151,7 +151,7 @@ abstract class Plex_Server_Library_SectionAbstract extends Plex_Server_Library
const ENDPOINT_CATEGORY_GENRE = 'genre';

/**
* Endpoint for retrieiving items for a section by year.
* Endpoint for retrieving items for a section by year.
*/
const ENDPOINT_CATEGORY_YEAR = 'year';

Expand All @@ -171,7 +171,7 @@ abstract class Plex_Server_Library_SectionAbstract extends Plex_Server_Library
const SEARCH_TYPE_SHOW = 2;

/**
* Parameter for searching teleivision episodes.
* Parameter for searching television episodes.
*/
const SEARCH_TYPE_EPISODE = 4;

Expand Down Expand Up @@ -297,8 +297,7 @@ protected function buildSearchEndpoint($type, $query)
* @uses Plex_Server_Library::getItems()
* @uses Plex_Server_Library_SectionAbstract::buildEndpoint()
* @uses Plex_Server_Library_SectionAbstract::ENDPOINT_CATEGORY_ALL
*
* return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
* @return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
*/
protected function getAllItems()
{
Expand Down Expand Up @@ -350,7 +349,7 @@ protected function getNewestItems()
* @uses Plex_Server_Library_SectionAbstract::buildEndpoint()
* @uses Plex_Server_Library_SectionAbstract::ENDPOINT_CATEGORY_RECENTLY_ADDED
*
* return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
* @return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
*/
protected function getRecentlyAddedSectionItems()
{
Expand All @@ -368,7 +367,7 @@ protected function getRecentlyAddedSectionItems()
* @uses Plex_Server_Library_SectionAbstract::buildEndpoint()
* @uses Plex_Server_Library_SectionAbstract::ENDPOINT_CATEGORY_ON_DECK
*
* return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
* @return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
*/
protected function getOnDeckSectionItems()
{
Expand All @@ -385,7 +384,7 @@ protected function getOnDeckSectionItems()
* @uses Plex_Server_Library_SectionAbstract::buildEndpoint()
* @uses Plex_Server_Library_SectionAbstract::ENDPOINT_CATEGORY_RECENTLY_VIEWED
*
* return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
* @return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
*/
protected function getRecentlyViewedItems()
{
Expand All @@ -406,7 +405,7 @@ protected function getRecentlyViewedItems()
* @uses Plex_Server_Library_SectionAbstract::buildEndpoint()
* @uses Plex_Server_Library_SectionAbstract::ENDPOINT_CATEGORY_COLLECTION
*
* return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
* @return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
*/
protected function getItemsByCollection($collectionKey)
{
Expand All @@ -432,7 +431,7 @@ protected function getItemsByCollection($collectionKey)
* @uses Plex_Server_Library_SectionAbstract::buildEndpoint()
* @uses Plex_Server_Library_SectionAbstract::ENDPOINT_CATEGORY_FIRST_CHARACTER
*
* return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
* @return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
*/
protected function getItemsByFirstCharacter($character)
{
Expand All @@ -459,7 +458,7 @@ protected function getItemsByFirstCharacter($character)
* @uses Plex_Server_Library_SectionAbstract::buildEndpoint()
* @uses Plex_Server_Library_SectionAbstract::ENDPOINT_CATEGORY_GENRE
*
* return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
* @return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
*/
protected function getItemsByGenre($genreKey)
{
Expand All @@ -485,7 +484,7 @@ protected function getItemsByGenre($genreKey)
* @uses Plex_Server_Library_SectionAbstract::buildEndpoint()
* @uses Plex_Server_Library_SectionAbstract::ENDPOINT_CATEGORY_YEAR
*
* return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
* @return Plex_Server_Library_ItemAbstract[] An array of Plex library items.
*/
protected function getItemsByYear($year)
{
Expand Down Expand Up @@ -579,7 +578,7 @@ protected function getPolymorphicItem($polymorphicData, $scopedToItem = FALSE)
// children or grandchildren. This has two implications. We can't
// search at this level, so we have to "get" then loop/match/return.
// It also means that to get the calling function we have to change
// the depth as there is an extra function inbetween.
// the depth as there is an extra function in between.
$depth = 2;
$functionType = 'search';

Expand Down Expand Up @@ -681,6 +680,7 @@ public function getGenres()
* @param string $name The name of the Plex server.
* @param string $address The IP address of the Plex server.
* @param integer $port The port on which the Plex server is listening.
* @param string $token The $token of the Plex server.
*
* @return Plex_Server_Library_SectionAbstract An instantiated section child
* class.
Expand Down

0 comments on commit 594bb4e

Please sign in to comment.