David PHAM-VAN

Improve documentation strings

@@ -5,6 +5,7 @@ @@ -5,6 +5,7 @@
5 - Apply BoxShape and BorderRadius to selected Checkbox [Joseph Grabinger] 5 - Apply BoxShape and BorderRadius to selected Checkbox [Joseph Grabinger]
6 - Fix Color.toHex() 6 - Fix Color.toHex()
7 - Improve Annotations placement 7 - Improve Annotations placement
  8 +- Improve documentation strings
8 9
9 ## 3.9.0 10 ## 3.9.0
10 11
@@ -25,58 +25,58 @@ import 'obj/object_dict.dart'; @@ -25,58 +25,58 @@ import 'obj/object_dict.dart';
25 import 'obj/smask.dart'; 25 import 'obj/smask.dart';
26 26
27 enum PdfBlendMode { 27 enum PdfBlendMode {
28 - /// Selects the source colour, ignoring the backdrop 28 + /// Selects the source color, ignoring the backdrop
29 normal, 29 normal,
30 30
31 - /// Multiplies the backdrop and source colour values 31 + /// Multiplies the backdrop and source color values
32 multiply, 32 multiply,
33 33
34 - /// Multiplies the complements of the backdrop and source colour values, 34 + /// Multiplies the complements of the backdrop and source color values,
35 /// then complements the result 35 /// then complements the result
36 screen, 36 screen,
37 37
38 - /// Multiplies or screens the colours, depending on the backdrop colour value 38 + /// Multiplies or screens the colors, depending on the backdrop color value
39 overlay, 39 overlay,
40 40
41 - /// Selects the darker of the backdrop and source colours 41 + /// Selects the darker of the backdrop and source colors
42 darken, 42 darken,
43 43
44 - /// Selects the lighter of the backdrop and source colours 44 + /// Selects the lighter of the backdrop and source colors
45 lighten, 45 lighten,
46 46
47 - /// Brightens the backdrop colour to reflect the source colour. 47 + /// Brightens the backdrop color to reflect the source color.
48 /// Painting with black produces no changes. 48 /// Painting with black produces no changes.
49 colorDodge, 49 colorDodge,
50 50
51 - /// Darkens the backdrop colour to reflect the source colour 51 + /// Darkens the backdrop color to reflect the source color
52 colorBurn, 52 colorBurn,
53 53
54 - /// Multiplies or screens the colours, depending on the source colour value 54 + /// Multiplies or screens the colors, depending on the source color value
55 hardLight, 55 hardLight,
56 56
57 - /// Darkens or lightens the colours, depending on the source colour value 57 + /// Darkens or lightens the colors, depending on the source color value
58 softLight, 58 softLight,
59 59
60 - /// Subtracts the darker of the two constituent colours from the lighter colour 60 + /// Subtracts the darker of the two constituent colors from the lighter color
61 difference, 61 difference,
62 62
63 /// Produces an effect similar to that of the Difference mode but lower in contrast 63 /// Produces an effect similar to that of the Difference mode but lower in contrast
64 exclusion, 64 exclusion,
65 65
66 - /// Creates a colour with the hue of the source colour and the saturation and  
67 - /// luminosity of the backdrop colour 66 + /// Creates a color with the hue of the source color and the saturation and
  67 + /// luminosity of the backdrop color
68 hue, 68 hue,
69 69
70 - /// Creates a colour with the saturation of the source colour and the hue and  
71 - /// luminosity of the backdrop colour 70 + /// Creates a color with the saturation of the source color and the hue and
  71 + /// luminosity of the backdrop color
72 saturation, 72 saturation,
73 73
74 - /// Creates a colour with the hue and saturation of the source colour and the  
75 - /// luminosity of the backdrop colour 74 + /// Creates a color with the hue and saturation of the source color and the
  75 + /// luminosity of the backdrop color
76 color, 76 color,
77 77
78 - /// Creates a colour with the luminosity of the source colour and the hue and  
79 - /// saturation of the backdrop colour 78 + /// Creates a color with the luminosity of the source color and the hue and
  79 + /// saturation of the backdrop color
80 luminosity, 80 luminosity,
81 } 81 }
82 82
@@ -35,17 +35,17 @@ import 'stream.dart'; @@ -35,17 +35,17 @@ import 'stream.dart';
35 35
36 /// Shape to be used at the corners of paths that are stroked 36 /// Shape to be used at the corners of paths that are stroked
37 enum PdfLineJoin { 37 enum PdfLineJoin {
38 - /// The outer edges of the strokes for the two segments shall beextended until they meet at an angle, as in a picture frame. If the segments meet at too sharp an angle (as defined by the miter limit parameter, a bevel join shall be used instead. 38 + /// The outer edges of the strokes for the two segments shall be extended until they meet at an angle, as in a picture frame. If the segments meet at too sharp an angle (as defined by the miter limit parameter, a bevel join shall be used instead.
39 miter, 39 miter,
40 40
41 - /// An arc of a circle with a diameter equal to the line width shall be drawn around the point where the two segments meet, connecting the outer edges of the strokes for the two segments. This pieslice-shaped figure shall be filled in, producing a rounded corner. 41 + /// An arc of a circle with a diameter equal to the line width shall be drawn around the point where the two segments meet, connecting the outer edges of the strokes for the two segments. This pie-slice-shaped figure shall be filled in, producing a rounded corner.
42 round, 42 round,
43 43
44 /// The two segments shall be finished with butt caps and the resulting notch beyond the ends of the segments shall be filled with a triangle. 44 /// The two segments shall be finished with butt caps and the resulting notch beyond the ends of the segments shall be filled with a triangle.
45 bevel 45 bevel
46 } 46 }
47 47
48 -/// Specify the shape that shall be used at the ends of open subpaths 48 +/// Specify the shape that shall be used at the ends of open sub paths
49 /// and dashes, when they are stroked. 49 /// and dashes, when they are stroked.
50 enum PdfLineCap { 50 enum PdfLineCap {
51 /// The stroke shall be squared off at the endpoint of the path. There shall be no projection beyond the end of the path. 51 /// The stroke shall be squared off at the endpoint of the path. There shall be no projection beyond the end of the path.
@@ -54,7 +54,7 @@ enum PdfLineCap { @@ -54,7 +54,7 @@ enum PdfLineCap {
54 /// A semicircular arc with a diameter equal to the line width shall be drawn around the endpoint and shall be filled in. 54 /// A semicircular arc with a diameter equal to the line width shall be drawn around the endpoint and shall be filled in.
55 round, 55 round,
56 56
57 - /// The stroke shall continue beyond the endpoint of the path for a distance equal to half the line width and shall besquared off. 57 + /// The stroke shall continue beyond the endpoint of the path for a distance equal to half the line width and shall be squared off.
58 square 58 square
59 } 59 }
60 60
@@ -216,7 +216,7 @@ class PdfGraphics { @@ -216,7 +216,7 @@ class PdfGraphics {
216 } 216 }
217 } 217 }
218 218
219 - /// Save the graphc context 219 + /// Save the graphic context
220 void saveContext() { 220 void saveContext() {
221 assert(() { 221 assert(() {
222 if (_page.pdfDocument.verbose) { 222 if (_page.pdfDocument.verbose) {
@@ -291,7 +291,7 @@ class PdfGraphics { @@ -291,7 +291,7 @@ class PdfGraphics {
291 291
292 /// Draws an ellipse 292 /// Draws an ellipse
293 /// 293 ///
294 - /// Use clockwise=false to draw the inside of a donnnut 294 + /// Use clockwise=false to draw the inside of a donut
295 void drawEllipse(double x, double y, double r1, double r2, 295 void drawEllipse(double x, double y, double r1, double r2,
296 {bool clockwise = true}) { 296 {bool clockwise = true}) {
297 assert(() { 297 assert(() {
@@ -51,7 +51,7 @@ class PdfCatalog extends PdfObjectDict { @@ -51,7 +51,7 @@ class PdfCatalog extends PdfObjectDict {
51 /// The page labels of the document 51 /// The page labels of the document
52 PdfPageLabels? pageLabels; 52 PdfPageLabels? pageLabels;
53 53
54 - /// These map the page modes just defined to the pagemodes setting of Pdf. 54 + /// These map the page modes just defined to the page modes setting of the Pdf.
55 static const List<String> _pdfPageModes = <String>[ 55 static const List<String> _pdfPageModes = <String>[
56 '/UseNone', 56 '/UseNone',
57 '/UseOutlines', 57 '/UseOutlines',
@@ -95,7 +95,7 @@ class PdfXrefTable extends PdfDataType { @@ -95,7 +95,7 @@ class PdfXrefTable extends PdfDataType {
95 /// Contains offsets of each object 95 /// Contains offsets of each object
96 final offsets = <PdfXref>[]; 96 final offsets = <PdfXref>[];
97 97
98 - /// Add a xross reference element to the set 98 + /// Add a cross reference element to the set
99 void add(PdfXref xref) { 99 void add(PdfXref xref) {
100 offsets.add(xref); 100 offsets.add(xref);
101 } 101 }