Skip to content

Commit 4642124

Browse files
njb90const-cloudinary
authored andcommitted
Add doc strings for classes.
1 parent 55de190 commit 4642124

File tree

9 files changed

+12
-9
lines changed

9 files changed

+12
-9
lines changed

src/Api/ApiResponse.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
use Cloudinary\ArrayUtils;
1515

1616
/**
17-
* Class ApiResponse
17+
* Defines the response returned by the API.
1818
*
1919
* @api
2020
*/

src/Configuration/AccountConfig.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
namespace Cloudinary\Configuration;
1212

1313
/**
14-
* Class AccountConfig
14+
* Defines the account configuration required to connect your application to Cloudinary.
15+
* **Learn more**: <a href="https://cloudinary.com/documentation/how_to_integrate_cloudinary#get_familiar_with_the_cloudinary_console" target="_blank">Get account details from the Cloudinary Console.</a>
1516
*
1617
* @api
1718
*/

src/Configuration/ApiConfig.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
namespace Cloudinary\Configuration;
1212

1313
/**
14-
* Class ApiConfig
14+
* Defines the global configuration when making requests to the Cloudinary API.
1515
*
1616
* @property string $uploadPrefix Used for changing default API host.
1717
* @property int|float $timeout Describing the timeout of the request in seconds.

src/Configuration/AuthTokenConfig.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
namespace Cloudinary\Configuration;
1212

1313
/**
14-
* Class AuthTokenConfig
14+
* Defines the configuration for delivering token-based authenticated media assets.
15+
* **Learn more**: <a href=https://cloudinary.com/documentation/control_access_to_media#delivering_token_based_authenticated_media_assets target="_blank">Delivering token based authenticated media assets</a>
1516
*
1617
* @api
1718
*/

src/Configuration/Configuration.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
use Psr\Http\Message\UriInterface;
1717

1818
/**
19-
* Class Configuration
19+
* Defines the available global configurations.
2020
*
2121
* @api
2222
*/

src/Configuration/LoggingConfig.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace Cloudinary\Configuration;
44

55
/**
6-
* Class LoggingConfig
6+
* Defines the global configuration for logging messages when using the SDK.
77
*
88
* @property array $file Settings for logging messages to a file.
99
* @property array $errorLog Settings for logging messages to PHP error_log() handler.

src/Configuration/ResponsiveBreakpointsConfig.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
use Cloudinary\Cache\Adapter\CacheAdapter;
1414

1515
/**
16-
* Class ResponsiveBreakpointsConfig
16+
* Defines the global responsive breakpoints configuration.
17+
* **Learn more**: <a href="https://cloudinary.com/documentation/image_upload_api_reference#responsive_breakpoints_parameter_request_settings" target="_blank">Responsive breakpoints</a>
1718
*
1819
* @api
1920
*/

src/Configuration/TagConfig.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
use Cloudinary\Tag\BaseTag;
1414

1515
/**
16-
* Class TagConfig
16+
* Defines the global configuration for html tags generated using the Cloudinary PHP SDK.
1717
*
1818
* @property string $videoPosterFormat Image format of the video poster.
1919
* @property string $quotesType Sets the type of the quotes to use (single or double). Default:

src/Configuration/UrlConfig.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
namespace Cloudinary\Configuration;
1212

1313
/**
14-
* Class UrlConfig
14+
* Defines the global configuration applied when generating Cloudinary URLs.
1515
*
1616
* @property bool $secure Force HTTPS URLs for resources even if they are embedded in non-secure HTTP pages.
1717
* @property bool $forceVersion By default set to self::DEFAULT_FORCE_VERSION.

0 commit comments

Comments
 (0)