Skip to content

Commit cdd4ee1

Browse files
nicolaasuninicolaasuni
committed
doc: minor documentation fixes
1 parent 1dd485a commit cdd4ee1

21 files changed

Lines changed: 60 additions & 59 deletions

‎resources/autoload.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* @package PdfGraph
1010
* @author Nicola Asuni <info@tecnick.com>
1111
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
12-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
12+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
1313
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
1414
*
1515
* This file is part of tc-lib-pdf-graph software library.

‎resources/debian/control‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ Vcs-Browser: https://github.com/~#VENDOR#~/~#PROJECT#~
1212
Package: ~#PKGNAME#~
1313
Provides: php-~#PROJECT#~
1414
Architecture: all
15-
Depends: php (>= 8.2.0), php-zip, php-tecnickcom-tc-lib-color (<< 3.0.0), php-tecnickcom-tc-lib-color (>= 2.13.0), php-tecnickcom-tc-lib-pdf-encrypt (<< 3.0.0), php-tecnickcom-tc-lib-pdf-encrypt (>= 2.9.0), ${misc:Depends}
15+
Depends: php (>= 8.2.0), php-zip, php-tecnickcom-tc-lib-color (<< 3.0.0), php-tecnickcom-tc-lib-color (>= 2.13.1), php-tecnickcom-tc-lib-pdf-encrypt (<< 3.0.0), php-tecnickcom-tc-lib-pdf-encrypt (>= 2.9.1), ${misc:Depends}
1616
Description: PHP PDF Graph Library
1717
PHP library containing PDF graphic and geometric methods.

‎resources/rpm/rpm.spec‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ BuildArch: noarch
1717
Requires: php(language) >= 8.2.0
1818
Requires: php-zlib
1919
Requires: php-composer(%{c_vendor}/tc-lib-color) < 3.0.0
20-
Requires: php-composer(%{c_vendor}/tc-lib-color) >= 2.13.0
20+
Requires: php-composer(%{c_vendor}/tc-lib-color) >= 2.13.1
2121
Requires: php-composer(%{c_vendor}/tc-lib-pdf-encrypt) < 3.0.0
22-
Requires: php-composer(%{c_vendor}/tc-lib-pdf-encrypt) >= 2.9.0
22+
Requires: php-composer(%{c_vendor}/tc-lib-pdf-encrypt) >= 2.9.1
2323

2424
Provides: php-composer(%{c_vendor}/%{gh_project}) = %{version}
2525
Provides: php-%{gh_project} = %{version}

‎src/Base.php‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* @package PdfGraph
1111
* @author Nicola Asuni <info@tecnick.com>
1212
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
13-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
13+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
1414
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
1515
*
1616
* This file is part of tc-lib-pdf-graph software library.
@@ -29,7 +29,7 @@
2929
* @package PdfGraph
3030
* @author Nicola Asuni <info@tecnick.com>
3131
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
32-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
32+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
3333
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
3434
*
3535
* @phpstan-type TTMatrix array{
@@ -184,6 +184,7 @@ abstract class Base
184184
* @param float $pagew Page width.
185185
* @param float $pageh Page height.
186186
* @param PdfColor $pdfColor Color object.
187+
* @param Encrypt $encrypt Encrypt object.
187188
* @param bool $pdfa True if we are in PDF/A mode.
188189
* @param bool $compress Set to false to disable stream compression.
189190
*/
@@ -324,7 +325,7 @@ public function getOutExtGState(int $pon): string
324325
}
325326

326327
/**
327-
* Returns the last extgstate ID to be used with XOBjects.
328+
* Returns the last extgstate ID to be used with XObjects.
328329
*
329330
* @return ?int
330331
*/
@@ -419,7 +420,7 @@ public function getOutExtGStateResources(): string
419420
}
420421

421422
/**
422-
* Get the PDF output string for ExtGState Resource Dictionary for XOBjects.
423+
* Get the PDF output string for ExtGState Resource Dictionary for XObjects.
423424
*
424425
* @param array<int> $keys Array of extgstates keys.
425426
*
@@ -630,7 +631,7 @@ protected function getOutGradientCols(array $grad, string $type): string
630631
* Get the PDF output string for the pattern and shading object
631632
*
632633
* @param GradientData $grad Array of gradient colors
633-
* @param int $objref Refrence object number
634+
* @param int $objref Reference object number
634635
*
635636
* @return string PDF command
636637
*

‎src/BlendMode.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* @package PdfGraph
1111
* @author Nicola Asuni <info@tecnick.com>
1212
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
13-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
13+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
1414
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
1515
*
1616
* This file is part of tc-lib-pdf-graph software library.
@@ -29,7 +29,7 @@
2929
* @package PdfGraph
3030
* @author Nicola Asuni <info@tecnick.com>
3131
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
32-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
32+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
3333
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
3434
*/
3535
enum BlendMode: string

‎src/Draw.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* @package PdfGraph
1111
* @author Nicola Asuni <info@tecnick.com>
1212
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
13-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
13+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
1414
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
1515
*
1616
* This file is part of tc-lib-pdf-graph software library.
@@ -28,7 +28,7 @@
2828
* @package PdfGraph
2929
* @author Nicola Asuni <info@tecnick.com>
3030
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
31-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
31+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
3232
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
3333
*
3434
* @phpstan-import-type StyleDataOpt from \Com\Tecnick\Pdf\Graph\Base
@@ -552,7 +552,7 @@ public function getRect(
552552
* @param float $hrad X-axis radius of the ellipse used to round off the corners of the rectangle.
553553
* @param float $vrad Y-axis radius of the ellipse used to round off the corners of the rectangle.
554554
* @param string $corner Round corners to draw: 0 (square i-corner) or 1 (rounded i-corner) in i-position.
555-
* Positions are int the following order: top right, bottom right, bottom left and
555+
* Positions are in the following order: top right, bottom right, bottom left and
556556
* top left.
557557
* @param string|PathPaintOp $mode Mode of rendering. @see getPathPaintOp()
558558
* @param StyleDataOpt $style Style.

‎src/Exception.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* @package PdfGraph
1111
* @author Nicola Asuni <info@tecnick.com>
1212
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
13-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
13+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
1414
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
1515
*
1616
* This file is part of tc-lib-pdf-graph software library.
@@ -28,7 +28,7 @@
2828
* @package PdfGraph
2929
* @author Nicola Asuni <info@tecnick.com>
3030
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
31-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
31+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
3232
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
3333
*/
3434
class Exception extends \Exception {}

‎src/Gradient.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* @package PdfGraph
1111
* @author Nicola Asuni <info@tecnick.com>
1212
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
13-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
13+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
1414
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
1515
*
1616
* This file is part of tc-lib-pdf-graph software library.
@@ -29,7 +29,7 @@
2929
* @package PdfGraph
3030
* @author Nicola Asuni <info@tecnick.com>
3131
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
32-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
32+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
3333
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
3434
*
3535
* @phpstan-import-type GradientData from \Com\Tecnick\Pdf\Graph\Base
@@ -135,8 +135,8 @@ public function getLinearGradient(
135135
* @param string $colorend Ending color.
136136
* @param array<float> $coords Array of the form (fx, fy, cx, cy, r) where
137137
* (fx, fy) is the starting point of the
138-
* gradient with $colorstart (be inside the
139-
* circle), (cx, cy) is the center of the
138+
* gradient with $colorstart (which should be
139+
* inside the circle), (cx, cy) is the center of the
140140
* circle with $colorend, and r is the radius
141141
* of the circle.
142142
*
@@ -197,7 +197,7 @@ public function getClippingRect(float $posx, float $posy, float $width, float $h
197197
}
198198

199199
/**
200-
* Rectangular clipping area.
200+
* Returns the transformation command that maps a gradient onto a rectangular area.
201201
*
202202
* @param float $posx Abscissa of the top left corner of the rectangle.
203203
* @param float $posy Ordinate of the top left corner of the rectangle.
@@ -299,7 +299,7 @@ public function getGradient(
299299
}
300300

301301
/**
302-
* Returns the last gradient ID to be used with XOBjects.
302+
* Returns the last gradient ID to be used with XObjects.
303303
*
304304
* @return ?int
305305
*/
@@ -666,7 +666,7 @@ public function getCoonsPatchMesh(
666666
}
667667

668668
/**
669-
* Paints registration bars with color transtions
669+
* Paints registration bars with color transitions
670670
*
671671
* @param float $posx Abscissa of the top left corner of the rectangle.
672672
* @param float $posy Ordinate of the top left corner of the rectangle.

‎src/PathPaintOp.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* @package PdfGraph
1111
* @author Nicola Asuni <info@tecnick.com>
1212
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
13-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
13+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
1414
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
1515
*
1616
* This file is part of tc-lib-pdf-graph software library.
@@ -31,7 +31,7 @@
3131
* @package PdfGraph
3232
* @author Nicola Asuni <info@tecnick.com>
3333
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
34-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
34+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
3535
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
3636
*/
3737
enum PathPaintOp: string

‎src/Raw.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* @package PdfGraph
1111
* @author Nicola Asuni <info@tecnick.com>
1212
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
13-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
13+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
1414
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
1515
*
1616
* This file is part of tc-lib-pdf-graph software library.
@@ -26,7 +26,7 @@
2626
* @package PdfGraph
2727
* @author Nicola Asuni <info@tecnick.com>
2828
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
29-
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
29+
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
3030
* @link https://github.com/tecnickcom/tc-lib-pdf-graph
3131
*/
3232
abstract class Raw extends \Com\Tecnick\Pdf\Graph\Transform
@@ -392,15 +392,15 @@ private function getRawEllipticalArcPoint(
392392
}
393393

394394
/**
395-
* Returns the angle in radiants between two vectors with the same origin point.
395+
* Returns the angle in radians between two vectors with the same origin point.
396396
* Angles are counted counter-clock wise.
397397
*
398398
* @param float $posx1 X coordinate of first vector point.
399399
* @param float $posy1 Y coordinate of first vector point.
400400
* @param float $posx2 X coordinate of second vector point.
401401
* @param float $posy2 Y coordinate of second vector point.
402402
*
403-
* @return float Angle in radiants
403+
* @return float Angle in radians
404404
*/
405405
public function getVectorsAngle(float $posx1, float $posy1, float $posx2, float $posy2): float
406406
{

0 commit comments

Comments
 (0)