Inspection of "add readme" - marksitko/laravel-unsplash - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (6b1ac9)

by Mark

created 2020-03-12 07:51 UTC

Doc Comments +5 added lines, -5 removed lines patch added patch discarded remove patch

@@ -9,7 +9,7 @@  discard block
 block discarded – undo
      * Get a single page from the list of all collections.
      * @link https://unsplash.com/documentation#list-collections
      *
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
+     * @return Collections
      */
     public function collectionsList()
     {
@@ -24,7 +24,7 @@  discard block
 block discarded – undo
      * Get a single page from the list of featured collections.
      * @link https://unsplash.com/documentation#list-featured-collections
      *
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
+     * @return Collections
      */
     public function featuredCollection()
     {
@@ -40,7 +40,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#get-a-collection
      *
      * @param int|string $id The collections’s ID. Required.
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
+     * @return Collections
      */
     public function showCollection( $id )
     {
@@ -56,7 +56,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#get-a-collections-photos
      *
      * @param int|string $id The collections’s ID. Required.
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
+     * @return Collections
      */
     public function showCollectionPhotos( $id )
     {
@@ -72,7 +72,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#list-a-collections-related-collections
      *
      * @param int|string $id The collections’s ID. Required.
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
+     * @return Collections
      */
     public function showCollectionRelatedCollections( $id )
     {

Please login to merge, or discard this patch.

src/Endpoints/Photos.php 1 patch

Doc Comments +5 added lines, -5 removed lines patch added patch discarded remove patch

@@ -9,7 +9,7 @@  discard block
 block discarded – undo
      * Get a single page from the list of all photos.
      * @link https://unsplash.com/documentation#list-photos
      *
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Photos
+     * @return Photos
      */
     public function photos()
     {
@@ -25,7 +25,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#get-a-photo
      *
      * @param string $id
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Photos
+     * @return Photos
      */
     public function photo( $id )
     {
@@ -39,7 +39,7 @@  discard block
 block discarded – undo
      * Get a random photo
      * @link https://unsplash.com/documentation#get-a-random-photo
      *
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Photos
+     * @return Photos
      */
     public function randomPhoto()
     {
@@ -54,7 +54,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#get-a-photos-statistics
      *
      * @param string $id
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Photos
+     * @return Photos
      */
     public function photosStatistics($id)
     {
@@ -69,7 +69,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#track-a-photo-download
      *
      * @param string $id
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Photos
+     * @return Photos
      */
     public function trackPhotoDownload($id)
     {

Please login to merge, or discard this patch.

src/Endpoints/Search.php 1 patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

@@ -9,7 +9,7 @@  discard block
 block discarded – undo
      * Get a single page of photo results for a query.
      * @link https://unsplash.com/documentation#search-photos
      *
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Search
+     * @return Search
      */
     public function search()
     {
@@ -24,7 +24,7 @@  discard block
 block discarded – undo
      * Get a single page of collection results for a query.
      * @link https://unsplash.com/documentation#search-collections
      *
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Search
+     * @return Search
      */
     public function searchCollections()
     {
@@ -39,7 +39,7 @@  discard block
 block discarded – undo
      * Get a single page of user results for a query.
      * @link https://unsplash.com/documentation#search-users
      *
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Search
+     * @return Search
      */
     public function searchUsers()
     {

Please login to merge, or discard this patch.

src/Endpoints/Stats.php 1 patch

Doc Comments +2 added lines, -2 removed lines patch added patch discarded remove patch

@@ -9,7 +9,7 @@  discard block
 block discarded – undo
      * Get a list of counts for all of Unsplash.
      * @link https://unsplash.com/documentation#totals
      *
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Stats
+     * @return Stats
      */
     public function totalStats()
     {
@@ -24,7 +24,7 @@  discard block
 block discarded – undo
      * Get the overall Unsplash stats for the past 30 days.
      * @link https://unsplash.com/documentation#month
      *
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Stats
+     * @return Stats
      */
     public function monthlyStats()
     {

Please login to merge, or discard this patch.

src/Endpoints/Users.php 1 patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

@@ -10,7 +10,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#get-a-users-public-profile
      *
      * @param string $username The user’s username. Required.
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Users
+     * @return Users
      */
     public function user( $username )
     {
@@ -26,7 +26,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#get-a-users-portfolio-link
      *
      * @param string $username The user’s username. Required.
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Users
+     * @return Users
      */
     public function userPortfolio( $username )
     {
@@ -42,7 +42,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#list-a-users-photos
      *
      * @param string $username The user’s username. Required.
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Users
+     * @return Users
      */
     public function userPhotos( $username )
     {
@@ -58,7 +58,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#list-a-users-liked-photos
      *
      * @param string $username The user’s username. Required.
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Users
+     * @return Users
      */
     public function userLikes( $username )
     {
@@ -74,7 +74,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#list-a-users-collections
      *
      * @param string $username The user’s username. Required.
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Users
+     * @return Users
      */
     public function userCollections( $username )
     {
@@ -91,7 +91,7 @@  discard block
 block discarded – undo
      * @link https://unsplash.com/documentation#get-a-users-statistics
      *
      * @param string $username The user’s username. Required.
-     * @return MarkSitko\LaravelUnsplash\Endpoints\Users
+     * @return Users
      */
     public function userStatistics( $username )
     {

Please login to merge, or discard this patch.

src/Http/HttpClient.php 1 patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

@@ -15,7 +15,7 @@  discard block
 block discarded – undo
 
     /**
     * Creates a new instance of HttpClient
-    * @return MarkSitko\LaravelUnsplash\Http\HttpClient
+    * @return HttpClient
     */
     public function __construct()
     {
@@ -27,7 +27,7 @@  discard block
 block discarded – undo
 
     /**
      * Initalize and store configuration values in class properties
-     * @return MarkSitko\LaravelUnsplash\Http\HttpClient
+     * @return HttpClient
      */
     private function initalizeConfiguration()
     {
@@ -42,7 +42,7 @@  discard block
 block discarded – undo
 
     /**
      * Instantiate the GuzzleHttp Client
-     * @return MarkSitko\LaravelUnsplash\Http\HttpClient
+     * @return HttpClient
      */
     private function createClient()
     {

Please login to merge, or discard this patch.

src/Unsplash.php 1 patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

@@ -42,7 +42,7 @@  discard block
 block discarded – undo
     /**
      * Creates a new instance of Unsplash.
      *
-     * @return MarkSitko\LaravelUnsplash\Unsplash
+     * @return Unsplash
      */
     public function __construct()
     {
@@ -143,7 +143,7 @@  discard block
 block discarded – undo
     /**
      * Builds the http request.
      *
-     * @return MarkSitko\LaravelUnsplash\Unsplash
+     * @return Unsplash
      */
     protected function buildResponse()
     {
@@ -156,7 +156,7 @@  discard block
 block discarded – undo
     /**
      * Initalize storage.
      *
-     * @return MarkSitko\LaravelUnsplash\Unsplash
+     * @return Unsplash
      */
     private function initalizeConfiguration()
     {

Please login to merge, or discard this patch.

		@@ -42,7 +42,7 @@ discard block
		block discarded – undo
42	42	/**
43	43	* Creates a new instance of Unsplash.
44	44	*
45		- * @return MarkSitko\LaravelUnsplash\Unsplash
	45	+ * @return Unsplash
46	46	*/
47	47	public function __construct()
48	48	{
		@@ -143,7 +143,7 @@ discard block
		block discarded – undo
143	143	/**
144	144	* Builds the http request.
145	145	*
146		- * @return MarkSitko\LaravelUnsplash\Unsplash
	146	+ * @return Unsplash
147	147	*/
148	148	protected function buildResponse()
149	149	{
		@@ -156,7 +156,7 @@ discard block
		block discarded – undo
156	156	/**
157	157	* Initalize storage.
158	158	*
159		- * @return MarkSitko\LaravelUnsplash\Unsplash
	159	+ * @return Unsplash
160	160	*/
161	161	private function initalizeConfiguration()
162	162	{

		@@ -9,7 +9,7 @@ discard block
		block discarded – undo
9	9	* Get a single page from the list of all collections.
10	10	* @link https://unsplash.com/documentation#list-collections
11	11	*
12		- * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
	12	+ * @return Collections
13	13	*/
14	14	public function collectionsList()
15	15	{
		@@ -24,7 +24,7 @@ discard block
		block discarded – undo
24	24	* Get a single page from the list of featured collections.
25	25	* @link https://unsplash.com/documentation#list-featured-collections
26	26	*
27		- * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
	27	+ * @return Collections
28	28	*/
29	29	public function featuredCollection()
30	30	{
		@@ -40,7 +40,7 @@ discard block
		block discarded – undo
40	40	* @link https://unsplash.com/documentation#get-a-collection
41	41	*
42	42	* @param int\|string $id The collections’s ID. Required.
43		- * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
	43	+ * @return Collections
44	44	*/
45	45	public function showCollection( $id )
46	46	{
		@@ -56,7 +56,7 @@ discard block
		block discarded – undo
56	56	* @link https://unsplash.com/documentation#get-a-collections-photos
57	57	*
58	58	* @param int\|string $id The collections’s ID. Required.
59		- * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
	59	+ * @return Collections
60	60	*/
61	61	public function showCollectionPhotos( $id )
62	62	{
		@@ -72,7 +72,7 @@ discard block
		block discarded – undo
72	72	* @link https://unsplash.com/documentation#list-a-collections-related-collections
73	73	*
74	74	* @param int\|string $id The collections’s ID. Required.
75		- * @return MarkSitko\LaravelUnsplash\Endpoints\Collections
	75	+ * @return Collections
76	76	*/
77	77	public function showCollectionRelatedCollections( $id )
78	78	{

		@@ -9,7 +9,7 @@ discard block
		block discarded – undo
9	9	* Get a single page of photo results for a query.
10	10	* @link https://unsplash.com/documentation#search-photos
11	11	*
12		- * @return MarkSitko\LaravelUnsplash\Endpoints\Search
	12	+ * @return Search
13	13	*/
14	14	public function search()
15	15	{
		@@ -24,7 +24,7 @@ discard block
		block discarded – undo
24	24	* Get a single page of collection results for a query.
25	25	* @link https://unsplash.com/documentation#search-collections
26	26	*
27		- * @return MarkSitko\LaravelUnsplash\Endpoints\Search
	27	+ * @return Search
28	28	*/
29	29	public function searchCollections()
30	30	{
		@@ -39,7 +39,7 @@ discard block
		block discarded – undo
39	39	* Get a single page of user results for a query.
40	40	* @link https://unsplash.com/documentation#search-users
41	41	*
42		- * @return MarkSitko\LaravelUnsplash\Endpoints\Search
	42	+ * @return Search
43	43	*/
44	44	public function searchUsers()
45	45	{

		@@ -9,7 +9,7 @@ discard block
		block discarded – undo
9	9	* Get a list of counts for all of Unsplash.
10	10	* @link https://unsplash.com/documentation#totals
11	11	*
12		- * @return MarkSitko\LaravelUnsplash\Endpoints\Stats
	12	+ * @return Stats
13	13	*/
14	14	public function totalStats()
15	15	{
		@@ -24,7 +24,7 @@ discard block
		block discarded – undo
24	24	* Get the overall Unsplash stats for the past 30 days.
25	25	* @link https://unsplash.com/documentation#month
26	26	*
27		- * @return MarkSitko\LaravelUnsplash\Endpoints\Stats
	27	+ * @return Stats
28	28	*/
29	29	public function monthlyStats()
30	30	{

		@@ -10,7 +10,7 @@ discard block
		block discarded – undo
10	10	* @link https://unsplash.com/documentation#get-a-users-public-profile
11	11	*
12	12	* @param string $username The user’s username. Required.
13		- * @return MarkSitko\LaravelUnsplash\Endpoints\Users
	13	+ * @return Users
14	14	*/
15	15	public function user( $username )
16	16	{
		@@ -26,7 +26,7 @@ discard block
		block discarded – undo
26	26	* @link https://unsplash.com/documentation#get-a-users-portfolio-link
27	27	*
28	28	* @param string $username The user’s username. Required.
29		- * @return MarkSitko\LaravelUnsplash\Endpoints\Users
	29	+ * @return Users
30	30	*/
31	31	public function userPortfolio( $username )
32	32	{
		@@ -42,7 +42,7 @@ discard block
		block discarded – undo
42	42	* @link https://unsplash.com/documentation#list-a-users-photos
43	43	*
44	44	* @param string $username The user’s username. Required.
45		- * @return MarkSitko\LaravelUnsplash\Endpoints\Users
	45	+ * @return Users
46	46	*/
47	47	public function userPhotos( $username )
48	48	{
		@@ -58,7 +58,7 @@ discard block
		block discarded – undo
58	58	* @link https://unsplash.com/documentation#list-a-users-liked-photos
59	59	*
60	60	* @param string $username The user’s username. Required.
61		- * @return MarkSitko\LaravelUnsplash\Endpoints\Users
	61	+ * @return Users
62	62	*/
63	63	public function userLikes( $username )
64	64	{
		@@ -74,7 +74,7 @@ discard block
		block discarded – undo
74	74	* @link https://unsplash.com/documentation#list-a-users-collections
75	75	*
76	76	* @param string $username The user’s username. Required.
77		- * @return MarkSitko\LaravelUnsplash\Endpoints\Users
	77	+ * @return Users
78	78	*/
79	79	public function userCollections( $username )
80	80	{
		@@ -91,7 +91,7 @@ discard block
		block discarded – undo
91	91	* @link https://unsplash.com/documentation#get-a-users-statistics
92	92	*
93	93	* @param string $username The user’s username. Required.
94		- * @return MarkSitko\LaravelUnsplash\Endpoints\Users
	94	+ * @return Users
95	95	*/
96	96	public function userStatistics( $username )
97	97	{

		@@ -15,7 +15,7 @@ discard block
		block discarded – undo
15	15
16	16	/**
17	17	* Creates a new instance of HttpClient
18		- * @return MarkSitko\LaravelUnsplash\Http\HttpClient
	18	+ * @return HttpClient
19	19	*/
20	20	public function __construct()
21	21	{
		@@ -27,7 +27,7 @@ discard block
		block discarded – undo
27	27
28	28	/**
29	29	* Initalize and store configuration values in class properties
30		- * @return MarkSitko\LaravelUnsplash\Http\HttpClient
	30	+ * @return HttpClient
31	31	*/
32	32	private function initalizeConfiguration()
33	33	{
		@@ -42,7 +42,7 @@ discard block
		block discarded – undo
42	42
43	43	/**
44	44	* Instantiate the GuzzleHttp Client
45		- * @return MarkSitko\LaravelUnsplash\Http\HttpClient
	45	+ * @return HttpClient
46	46	*/
47	47	private function createClient()
48	48	{

marksitko / laravel-unsplash

Branch — master (6b1ac9)

Category

Doc Comments +5 added lines, -5 removed lines patch added patch discarded remove patch

Doc Comments +5 added lines, -5 removed lines patch added patch discarded remove patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

Doc Comments +2 added lines, -2 removed lines patch added patch discarded remove patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch