Skip to content

Commit 402aac4

Browse files
ars18wrwiText-CI
ars18wrw
authored and
iText-CI
committed
Add missing documentation to several layout classes
DEVSIX-6640 Autoported commit. Original commit hash: [22b28c21a]
1 parent 23388ca commit 402aac4

File tree

9 files changed

+196
-11
lines changed

9 files changed

+196
-11
lines changed

‎itext/itext.layout/itext/layout/borders/Border.cs‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -474,6 +474,35 @@ public enum Side {
474474
LEFT
475475
}
476476

477+
/// <summary>
478+
/// Gets a
479+
/// <see cref="iText.Kernel.Geom.Point"/>
480+
/// in which two lines intersect.
481+
/// </summary>
482+
/// <param name="lineBeg">
483+
/// a
484+
/// <see cref="iText.Kernel.Geom.Point"/>
485+
/// which defines some point on the first line
486+
/// </param>
487+
/// <param name="lineEnd">
488+
/// a
489+
/// <see cref="iText.Kernel.Geom.Point"/>
490+
/// which defines another point on the first line
491+
/// </param>
492+
/// <param name="clipLineBeg">
493+
/// a
494+
/// <see cref="iText.Kernel.Geom.Point"/>
495+
/// which defines some point on the second line
496+
/// </param>
497+
/// <param name="clipLineEnd">
498+
/// a
499+
/// <see cref="iText.Kernel.Geom.Point"/>
500+
/// which defines another point on the second line
501+
/// </param>
502+
/// <returns>
503+
/// the intersection
504+
/// <see cref="iText.Kernel.Geom.Point"/>
505+
/// </returns>
477506
protected internal virtual Point GetIntersectionPoint(Point lineBeg, Point lineEnd, Point clipLineBeg, Point
478507
clipLineEnd) {
479508
double A1 = lineBeg.GetY() - lineEnd.GetY();

‎itext/itext.layout/itext/layout/borders/GrooveBorder.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ source product.
4545
using iText.Kernel.Pdf.Canvas;
4646

4747
namespace iText.Layout.Borders {
48+
/// <summary>
49+
/// Represents a
50+
/// <see cref="Border3D"/>
51+
/// with a groove effect being applied.
52+
/// </summary>
4853
public class GrooveBorder : Border3D {
4954
/// <summary>Creates a GrooveBorder instance with the specified width.</summary>
5055
/// <remarks>Creates a GrooveBorder instance with the specified width. The color is set to the predefined gray.

‎itext/itext.layout/itext/layout/borders/InsetBorder.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ source product.
4545
using iText.Kernel.Pdf.Canvas;
4646

4747
namespace iText.Layout.Borders {
48+
/// <summary>
49+
/// Represents a
50+
/// <see cref="Border3D"/>
51+
/// with an inset effect being applied.
52+
/// </summary>
4853
public class InsetBorder : Border3D {
4954
/// <summary>Creates an InsetBorder instance with the specified width.</summary>
5055
/// <remarks>Creates an InsetBorder instance with the specified width. The color is set to the predefined gray.

‎itext/itext.layout/itext/layout/borders/OutsetBorder.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ source product.
4545
using iText.Kernel.Pdf.Canvas;
4646

4747
namespace iText.Layout.Borders {
48+
/// <summary>
49+
/// Represents a
50+
/// <see cref="Border3D"/>
51+
/// with an outset effect being applied.
52+
/// </summary>
4853
public class OutsetBorder : Border3D {
4954
/// <summary>Creates an OutsetBorder instance with the specified width.</summary>
5055
/// <remarks>Creates an OutsetBorder instance with the specified width. The color is set to the predefined gray.

‎itext/itext.layout/itext/layout/borders/RidgeBorder.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ source product.
4545
using iText.Kernel.Pdf.Canvas;
4646

4747
namespace iText.Layout.Borders {
48+
/// <summary>
49+
/// Represents a
50+
/// <see cref="Border3D"/>
51+
/// with a ridge effect being applied.
52+
/// </summary>
4853
public class RidgeBorder : Border3D {
4954
/// <summary>Creates a RidgeBorder instance with the specified width.</summary>
5055
/// <remarks>Creates a RidgeBorder instance with the specified width. The color is set to the predefined gray.

‎itext/itext.layout/itext/layout/element/Div.cs‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,33 @@ public override AccessibilityProperties GetAccessibilityProperties() {
106106
return tagProperties;
107107
}
108108

109+
/// <summary>
110+
/// Defines whether the
111+
/// <see cref="Div"/>
112+
/// should occupy all the space left in the available area
113+
/// in case it is the last element in this area.
114+
/// </summary>
115+
/// <param name="fillArea">defines whether the available area should be filled</param>
116+
/// <returns>
117+
/// this
118+
/// <see cref="Div"/>
119+
/// </returns>
109120
public virtual Div SetFillAvailableArea(bool fillArea) {
110121
SetProperty(Property.FILL_AVAILABLE_AREA, fillArea);
111122
return this;
112123
}
113124

125+
/// <summary>
126+
/// Defines whether the
127+
/// <see cref="Div"/>
128+
/// should occupy all the space left in the available area
129+
/// in case the area has been split and it is the last element in the split part of this area.
130+
/// </summary>
131+
/// <param name="fillAreaOnSplit">defines whether the available area should be filled</param>
132+
/// <returns>
133+
/// this
134+
/// <see cref="Div"/>
135+
/// </returns>
114136
public virtual Div SetFillAvailableAreaOnSplit(bool fillAreaOnSplit) {
115137
SetProperty(Property.FILL_AVAILABLE_AREA_ON_SPLIT, fillAreaOnSplit);
116138
return this;

‎itext/itext.layout/itext/layout/element/Paragraph.cs‎

Lines changed: 52 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,27 +87,55 @@ public Paragraph(Text text) {
8787
Add(text);
8888
}
8989

90-
/// <summary>Adds a piece of text to the Paragraph</summary>
90+
/// <summary>
91+
/// Adds a piece of text to this
92+
/// <see cref="Paragraph"/>.
93+
/// </summary>
9194
/// <param name="text">
9295
/// the content to be added, as a
9396
/// <see cref="System.String"/>
9497
/// </param>
95-
/// <returns>this Paragraph</returns>
98+
/// <returns>
99+
/// this
100+
/// <see cref="Paragraph"/>
101+
/// </returns>
96102
public virtual iText.Layout.Element.Paragraph Add(String text) {
97103
return Add(new Text(text));
98104
}
99105

100-
/// <summary>Adds a layout element to the Paragraph.</summary>
106+
/// <summary>
107+
/// Adds a
108+
/// <see cref="ILeafElement">element</see>
109+
/// to this
110+
/// <see cref="Paragraph"/>.
111+
/// </summary>
101112
/// <param name="element">
102113
/// the content to be added, any
103114
/// <see cref="ILeafElement"/>
104115
/// </param>
105-
/// <returns>this Paragraph</returns>
116+
/// <returns>
117+
/// this
118+
/// <see cref="Paragraph"/>
119+
/// </returns>
106120
public virtual iText.Layout.Element.Paragraph Add(ILeafElement element) {
107121
childElements.Add(element);
108122
return this;
109123
}
110124

125+
/// <summary>
126+
/// Adds an
127+
/// <see cref="IBlockElement">element</see>
128+
/// to this
129+
/// <see cref="Paragraph"/>.
130+
/// </summary>
131+
/// <param name="element">
132+
/// the content to be added, any
133+
/// <see cref="IBlockElement"/>
134+
/// </param>
135+
/// <returns>
136+
/// this
137+
/// <see cref="Paragraph"/>
138+
/// </returns>
111139
public virtual iText.Layout.Element.Paragraph Add(IBlockElement element) {
112140
childElements.Add(element);
113141
return this;
@@ -116,14 +144,18 @@ public virtual iText.Layout.Element.Paragraph Add(IBlockElement element) {
116144
/// <summary>
117145
/// Adds a
118146
/// <see cref="System.Collections.IList{E}"/>
119-
/// of layout elements to the Paragraph.
147+
/// of layout elements to this
148+
/// <see cref="Paragraph"/>.
120149
/// </summary>
121150
/// <param name="elements">the content to be added</param>
122151
/// <typeparam name="T2">
123152
/// any
124153
/// <see cref="ILeafElement"/>
125154
/// </typeparam>
126-
/// <returns>this Paragraph</returns>
155+
/// <returns>
156+
/// this
157+
/// <see cref="Paragraph"/>
158+
/// </returns>
127159
public virtual iText.Layout.Element.Paragraph AddAll<T2>(IList<T2> elements)
128160
where T2 : ILeafElement {
129161
foreach (ILeafElement element in elements) {
@@ -132,13 +164,19 @@ public virtual iText.Layout.Element.Paragraph AddAll<T2>(IList<T2> elements)
132164
return this;
133165
}
134166

135-
/// <summary>Adds an unspecified amount of tabstop elements as properties to the Paragraph.</summary>
167+
/// <summary>
168+
/// Adds an unspecified amount of tabstop elements as properties to this
169+
/// <see cref="Paragraph"/>.
170+
/// </summary>
136171
/// <param name="tabStops">
137172
/// the
138173
/// <see cref="TabStop">tabstop(s)</see>
139174
/// to be added as properties
140175
/// </param>
141-
/// <returns>this Paragraph</returns>
176+
/// <returns>
177+
/// this
178+
/// <see cref="Paragraph"/>
179+
/// </returns>
142180
/// <seealso cref="TabStop"/>
143181
public virtual iText.Layout.Element.Paragraph AddTabStops(params TabStop[] tabStops) {
144182
AddTabStopsAsProperty(JavaUtil.ArraysAsList(tabStops));
@@ -148,14 +186,18 @@ public virtual iText.Layout.Element.Paragraph AddTabStops(params TabStop[] tabSt
148186
/// <summary>
149187
/// Adds a
150188
/// <see cref="System.Collections.IList{E}"/>
151-
/// of tabstop elements as properties to the Paragraph.
189+
/// of tabstop elements as properties to this
190+
/// <see cref="Paragraph"/>.
152191
/// </summary>
153192
/// <param name="tabStops">
154193
/// the list of
155194
/// <see cref="TabStop"/>
156195
/// s to be added as properties
157196
/// </param>
158-
/// <returns>this Paragraph</returns>
197+
/// <returns>
198+
/// this
199+
/// <see cref="Paragraph"/>
200+
/// </returns>
159201
/// <seealso cref="TabStop"/>
160202
public virtual iText.Layout.Element.Paragraph AddTabStops(IList<TabStop> tabStops) {
161203
AddTabStopsAsProperty(tabStops);

‎itext/itext.layout/itext/layout/element/Table.cs‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -952,16 +952,56 @@ public virtual IList<Border> GetLastRowBottomBorder() {
952952
return horizontalBorder;
953953
}
954954

955+
/// <summary>
956+
/// Defines whether the
957+
/// <see cref="Table"/>
958+
/// should be extended to occupy all the space left in the available area
959+
/// in case it is the last element in this area.
960+
/// </summary>
961+
/// <param name="isExtended">
962+
/// defines whether the
963+
/// <see cref="Table"/>
964+
/// should be extended
965+
/// </param>
966+
/// <returns>
967+
/// this
968+
/// <see cref="Table"/>
969+
/// </returns>
955970
public virtual iText.Layout.Element.Table SetExtendBottomRow(bool isExtended) {
956971
SetProperty(Property.FILL_AVAILABLE_AREA, isExtended);
957972
return this;
958973
}
959974

975+
/// <summary>
976+
/// Defines whether the
977+
/// <see cref="Table"/>
978+
/// should be extended to occupy all the space left in the available area
979+
/// in case the area has been split and it is the last element in the split part of this area.
980+
/// </summary>
981+
/// <param name="isExtended">
982+
/// defines whether the
983+
/// <see cref="Table"/>
984+
/// should be extended
985+
/// </param>
986+
/// <returns>
987+
/// this
988+
/// <see cref="Table"/>
989+
/// </returns>
960990
public virtual iText.Layout.Element.Table SetExtendBottomRowOnSplit(bool isExtended) {
961991
SetProperty(Property.FILL_AVAILABLE_AREA_ON_SPLIT, isExtended);
962992
return this;
963993
}
964994

995+
/// <summary>Sets the type of border collapse.</summary>
996+
/// <param name="collapsePropertyValue">
997+
///
998+
/// <see cref="iText.Layout.Properties.BorderCollapsePropertyValue"/>
999+
/// to be set as the border collapse type
1000+
/// </param>
1001+
/// <returns>
1002+
/// this
1003+
/// <see cref="Table"/>
1004+
/// </returns>
9651005
public virtual iText.Layout.Element.Table SetBorderCollapse(BorderCollapsePropertyValue collapsePropertyValue
9661006
) {
9671007
SetProperty(Property.BORDER_COLLAPSE, collapsePropertyValue);
@@ -974,6 +1014,22 @@ public virtual iText.Layout.Element.Table SetBorderCollapse(BorderCollapseProper
9741014
return this;
9751015
}
9761016

1017+
/// <summary>
1018+
/// Sets the horizontal spacing between this
1019+
/// <see cref="Table">table</see>
1020+
/// 's
1021+
/// <see cref="Cell">cells</see>.
1022+
/// </summary>
1023+
/// <param name="spacing">
1024+
/// a horizontal spacing between this
1025+
/// <see cref="Table">table</see>
1026+
/// 's
1027+
/// <see cref="Cell">cells</see>
1028+
/// </param>
1029+
/// <returns>
1030+
/// this
1031+
/// <see cref="Table"/>
1032+
/// </returns>
9771033
public virtual iText.Layout.Element.Table SetHorizontalBorderSpacing(float spacing) {
9781034
SetProperty(Property.HORIZONTAL_BORDER_SPACING, spacing);
9791035
if (null != header) {
@@ -985,6 +1041,22 @@ public virtual iText.Layout.Element.Table SetHorizontalBorderSpacing(float spaci
9851041
return this;
9861042
}
9871043

1044+
/// <summary>
1045+
/// Sets the vertical spacing between this
1046+
/// <see cref="Table">table</see>
1047+
/// 's
1048+
/// <see cref="Cell">cells</see>.
1049+
/// </summary>
1050+
/// <param name="spacing">
1051+
/// a vertical spacing between this
1052+
/// <see cref="Table">table</see>
1053+
/// 's
1054+
/// <see cref="Cell">cells</see>
1055+
/// </param>
1056+
/// <returns>
1057+
/// this
1058+
/// <see cref="Table"/>
1059+
/// </returns>
9881060
public virtual iText.Layout.Element.Table SetVerticalBorderSpacing(float spacing) {
9891061
SetProperty(Property.VERTICAL_BORDER_SPACING, spacing);
9901062
if (null != header) {

‎port-hash‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
f3771f179d110abe0b9ef8e28d6283f93d849268
1+
22b28c21a6e4eba260a7470f015d7391d63cfbec

0 commit comments

Comments
 (0)