Improve doc strings

sharon-yelenik · web-flow · commit 9a3a22ea0eff · 2024-12-17T01:37:31.000+02:00
diff --git a/src/Asset/BaseMediaAsset.php b/src/Asset/BaseMediaAsset.php
@@ -101,7 +101,7 @@ public function setTransformation(CommonTransformation $transformation)
     abstract public function getTransformation();
 
     /**
-     * Adds (appends) a transformation.
+     * Adds (appends) a transformation in URL syntax to the current chain. A transformation is a set of instructions for adjusting images or videos—such as resizing, cropping, applying filters, adding overlays, or optimizing formats. For a detailed listing of all transformations, see the [Transformation Reference](https://cloudinary.com/documentation/transformation_reference) or the [PHP reference](https://cloudinary.com/documentation/sdks/php/php-transformation-builder/index.html).
      *
      * Appended transformation is nested.
      *
diff --git a/src/Asset/Descriptor/AssetTransformation.php b/src/Asset/Descriptor/AssetTransformation.php
@@ -157,7 +157,7 @@ public function importJson($json)
     }
 
     /**
-     * Adds (appends) a transformation.
+     * Adds (appends) a transformation in URL syntax to the current chain. A transformation is a set of instructions for adjusting images or videos—such as resizing, cropping, applying filters, adding overlays, or optimizing formats. For a detailed listing of all transformations, see the [Transformation Reference](https://cloudinary.com/documentation/transformation_reference) or the [PHP reference](https://cloudinary.com/documentation/sdks/php/php-transformation-builder/index.html).
      *
      * Appended transformation is nested.
      *
diff --git a/src/Tag/BaseImageTag.php b/src/Tag/BaseImageTag.php
@@ -174,7 +174,7 @@ public function jsonSerialize()
     }
 
     /**
-     * Adds (appends) a transformation.
+     * Adds (appends) a transformation in URL syntax to the current chain. A transformation is a set of instructions for adjusting images or videos—such as resizing, cropping, applying filters, adding overlays, or optimizing formats. For a detailed listing of all transformations, see the [Transformation Reference](https://cloudinary.com/documentation/transformation_reference) or the [PHP reference](https://cloudinary.com/documentation/sdks/php/php-transformation-builder/index.html).
      *
      * Appended transformation is nested.
      *
diff --git a/src/Tag/ImageTag.php b/src/Tag/ImageTag.php
@@ -15,6 +15,8 @@
 /**
  * Generates an HTML `<img>` tag with the `src` attribute set to the transformation URL, optional `srcset` and other
  * specified attributes.
+ * 
+ * For more information, see the [PHP SDK guide](https://cloudinary.com/documentation/php_image_manipulation#deliver_and_transform_images).
  *
  * @api
  */
diff --git a/src/Tag/VideoTag.php b/src/Tag/VideoTag.php
@@ -343,7 +343,7 @@ public function jsonSerialize()
     }
 
     /**
-     * Adds (appends) a transformation.
+     * Adds (appends) a transformation in URL syntax to the current chain. A transformation is a set of instructions for adjusting images or videos—such as resizing, cropping, applying filters, adding overlays, or optimizing formats. For a detailed listing of all transformations, see the [Transformation Reference](https://cloudinary.com/documentation/transformation_reference) or the [PHP reference](https://cloudinary.com/documentation/sdks/php/php-transformation-builder/index.html).
      *
      * Appended transformation is nested.
      *

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ public function setTransformation(CommonTransformation $transformation)`
`101`	`101`	`abstract public function getTransformation();`
`102`	`102`
`103`	`103`	`/**`
`104`		`- * Adds (appends) a transformation.`
	`104`	`+ * Adds (appends) a transformation in URL syntax to the current chain. A transformation is a set of instructions for adjusting images or videos—such as resizing, cropping, applying filters, adding overlays, or optimizing formats. For a detailed listing of all transformations, see the [Transformation Reference](https://cloudinary.com/documentation/transformation_reference) or the [PHP reference](https://cloudinary.com/documentation/sdks/php/php-transformation-builder/index.html).`
`105`	`105`	`*`
`106`	`106`	`* Appended transformation is nested.`
`107`	`107`	`*`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,7 @@ public function importJson($json)`
`157`	`157`	`}`
`158`	`158`
`159`	`159`	`/**`
`160`		`- * Adds (appends) a transformation.`
	`160`	`+ * Adds (appends) a transformation in URL syntax to the current chain. A transformation is a set of instructions for adjusting images or videos—such as resizing, cropping, applying filters, adding overlays, or optimizing formats. For a detailed listing of all transformations, see the [Transformation Reference](https://cloudinary.com/documentation/transformation_reference) or the [PHP reference](https://cloudinary.com/documentation/sdks/php/php-transformation-builder/index.html).`
`161`	`161`	`*`
`162`	`162`	`* Appended transformation is nested.`
`163`	`163`	`*`
Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,7 @@ public function jsonSerialize()`
`174`	`174`	`}`
`175`	`175`
`176`	`176`	`/**`
`177`		`- * Adds (appends) a transformation.`
	`177`	`+ * Adds (appends) a transformation in URL syntax to the current chain. A transformation is a set of instructions for adjusting images or videos—such as resizing, cropping, applying filters, adding overlays, or optimizing formats. For a detailed listing of all transformations, see the [Transformation Reference](https://cloudinary.com/documentation/transformation_reference) or the [PHP reference](https://cloudinary.com/documentation/sdks/php/php-transformation-builder/index.html).`
`178`	`178`	`*`
`179`	`179`	`* Appended transformation is nested.`
`180`	`180`	`*`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@`
`15`	`15`	`/**`
`16`	`16`	* Generates an HTML `<img>` tag with the `src` attribute set to the transformation URL, optional `srcset` and other
`17`	`17`	`* specified attributes.`
	`18`	`+ *`
	`19`	`+ * For more information, see the [PHP SDK guide](https://cloudinary.com/documentation/php_image_manipulation#deliver_and_transform_images).`
`18`	`20`	`*`
`19`	`21`	`* @api`
`20`	`22`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -343,7 +343,7 @@ public function jsonSerialize()`
`343`	`343`	`}`
`344`	`344`
`345`	`345`	`/**`
`346`		`- * Adds (appends) a transformation.`
	`346`	`+ * Adds (appends) a transformation in URL syntax to the current chain. A transformation is a set of instructions for adjusting images or videos—such as resizing, cropping, applying filters, adding overlays, or optimizing formats. For a detailed listing of all transformations, see the [Transformation Reference](https://cloudinary.com/documentation/transformation_reference) or the [PHP reference](https://cloudinary.com/documentation/sdks/php/php-transformation-builder/index.html).`
`347`	`347`	`*`
`348`	`348`	`* Appended transformation is nested.`
`349`	`349`	`*`