Skip to content

Commit d2ac6df

Browse files
yulian-gaponenkoiText-CI
authored andcommitted
Fix javadocs in order in order to make them portable to C# code documentation
Also remove </li> and </dt>, </dd> from javadocs in kernel module. In javadocs it's enough to specify only openning tags and we aim at less cluttered documentation. DEVSIX-3096 Autoported commit. Original commit hash: [95035e6c7] Manual files: kernel/src/main/java/com/itextpdf/kernel/pdf/PdfDate.java kernel/src/main/java/com/itextpdf/kernel/xmp/impl/CountOutputStream.java kernel/src/main/java/com/itextpdf/kernel/xmp/impl/ParseRDF.java
1 parent 1056da0 commit d2ac6df

39 files changed

+248
-253
lines changed

itext/itext.kernel/itext/kernel/font/PdfFont.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -389,8 +389,10 @@ public virtual bool IsSubset() {
389389
/// </summary>
390390
/// <remarks>
391391
/// Indicates if all the glyphs and widths for that particular
392-
/// encoding should be included in the document. When set to <CODE>true</CODE>
393-
/// only the glyphs used will be included in the font. When set to <CODE>false&lt;/CODE
392+
/// encoding should be included in the document. When set to
393+
/// <see langword="true"/>
394+
/// only the glyphs used will be included in the font. When set to
395+
/// <see langword="false"/>
394396
/// the full font will be included and all subset ranges will be removed.
395397
/// </remarks>
396398
/// <param name="subset">new value of property subset</param>

itext/itext.kernel/itext/kernel/geom/AffineTransform.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -213,28 +213,28 @@ public AffineTransform(double[] matrix) {
213213
/// <ul>
214214
/// <li>
215215
/// <see cref="TYPE_IDENTITY"/>
216-
/// - new basis equals original one and zero translation</li>
216+
/// - new basis equals original one and zero translation
217217
/// <li>
218218
/// <see cref="TYPE_TRANSLATION"/>
219-
/// - translation vector isn't zero</li>
219+
/// - translation vector isn't zero
220220
/// <li>
221221
/// <see cref="TYPE_UNIFORM_SCALE"/>
222-
/// - vectors length of new basis equals</li>
222+
/// - vectors length of new basis equals
223223
/// <li>
224224
/// <see cref="TYPE_GENERAL_SCALE"/>
225-
/// - vectors length of new basis doesn't equal</li>
225+
/// - vectors length of new basis doesn't equal
226226
/// <li>
227227
/// <see cref="TYPE_FLIP"/>
228-
/// - new basis vector orientation differ from original one</li>
228+
/// - new basis vector orientation differ from original one
229229
/// <li>
230230
/// <see cref="TYPE_QUADRANT_ROTATION"/>
231-
/// - new basis is rotated by 90, 180, 270, or 360 degrees</li>
231+
/// - new basis is rotated by 90, 180, 270, or 360 degrees
232232
/// <li>
233233
/// <see cref="TYPE_GENERAL_ROTATION"/>
234-
/// - new basis is rotated by arbitrary angle</li>
234+
/// - new basis is rotated by arbitrary angle
235235
/// <li>
236236
/// <see cref="TYPE_GENERAL_TRANSFORM"/>
237-
/// - transformation can't be inversed</li>
237+
/// - transformation can't be inversed
238238
/// </ul>
239239
/// </remarks>
240240
/// <returns>the type of this AffineTransform</returns>

itext/itext.kernel/itext/kernel/pdf/PdfDate.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,17 @@ namespace iText.Kernel.Pdf {
5050
/// <summary>
5151
/// <c>PdfDate</c>
5252
/// is the PDF date object.
53-
/// <P>
53+
/// <para/>
5454
/// PDF defines a standard date format. The PDF date format closely follows the format
5555
/// defined by the international standard ASN.1 (Abstract Syntax Notation One, defined
5656
/// in CCITT X.208 or ISO/IEC 8824). A date is a
5757
/// <c>PdfString</c>
5858
/// of the form:
59-
/// <P><BLOCKQUOTE>
59+
/// <para/>
60+
/// <c>
6061
/// (D:YYYYMMDDHHmmSSOHH'mm')
61-
/// </BLOCKQUOTE><P>
62+
/// </c>
63+
/// <para/>
6264
/// See also ISO-320001 7.9.4, "Dates".
6365
/// </summary>
6466
/// <seealso cref="PdfString"/>

itext/itext.kernel/itext/kernel/pdf/PdfObject.cs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -516,12 +516,18 @@ protected internal virtual void CopyContent(PdfObject from, PdfDocument document
516516
/// <summary>
517517
/// Processes two cases of object copying:
518518
/// <ol>
519-
/// <li>copying to the other document</li>
520-
/// <li>cloning inside of the current document</li>
519+
/// <li>copying to the other document
520+
/// <li>cloning inside of the current document
521521
/// </ol>
522522
/// <p>
523-
/// This two cases are distinguished by the state of <code>document</code> parameter:
524-
/// the second case is processed if <code>document</code> is <code>null</code>.
523+
/// This two cases are distinguished by the state of
524+
/// <c>document</c>
525+
/// parameter:
526+
/// the second case is processed if
527+
/// <c>document</c>
528+
/// is
529+
/// <see langword="null"/>
530+
/// .
525531
/// </summary>
526532
/// <param name="documentTo">if not null: document to copy object to; otherwise indicates that object is to be cloned.
527533
/// </param>

itext/itext.kernel/itext/kernel/pdf/PdfString.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,8 @@ namespace iText.Kernel.Pdf {
6666
/// way to represent characters outside the printable ASCII character set.<br />
6767
/// This object is described in the 'Portable Document Format Reference Manual
6868
/// version 1.7' section 3.2.3 (page 53-56).
69-
/// <p>
70-
/// <see cref="PdfObject"/>
7169
/// </summary>
70+
/// <seealso cref="PdfObject"/>
7271
public class PdfString : PdfPrimitiveObject {
7372
protected internal String value;
7473

itext/itext.kernel/itext/kernel/pdf/PdfTextArray.cs

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,26 @@ source product.
4747
using iText.Kernel.Font;
4848

4949
namespace iText.Kernel.Pdf {
50-
/// <summary><CODE>PdfTextArray</CODE> defines an array with displacements and <CODE>PdfString</CODE>-objects.
51-
/// </summary>
52-
/// <remarks>
53-
/// <CODE>PdfTextArray</CODE> defines an array with displacements and <CODE>PdfString</CODE>-objects.
50+
/// <summary>
51+
/// <see cref="PdfTextArray"/>
52+
/// defines an array with displacements and
53+
/// <see cref="PdfString"/>
54+
/// -objects.
5455
/// <P>
55-
/// A <CODE>PdfTextArray</CODE> is used with the operator <VAR>TJ</VAR> in <CODE>PdfCanvas</CODE>.
56-
/// The first object in this array has to be a <CODE>PdfString</CODE>;
56+
/// A
57+
/// <see cref="PdfTextArray"/>
58+
/// is used with the operator TJ in
59+
/// <see cref="iText.Kernel.Pdf.Canvas.PdfCanvas"/>
60+
/// .
61+
/// The first object in this array has to be a
62+
/// <see cref="PdfString"/>
63+
/// ;
5764
/// see reference manual version 1.3 section 8.7.5, pages 346-347.
5865
/// OR
5966
/// see reference manual version 1.6 section 5.3.2, pages 378-379.
6067
/// To emit a more efficient array, we consolidate repeated numbers or strings into single array entries.
61-
/// "add( 50 ); add( -50 );" will REMOVE the combined zero from the array.
62-
/// </remarks>
68+
/// For example: "add( 50 ); add( -50 );" will REMOVE the combined zero from the array.
69+
/// </summary>
6370
public class PdfTextArray : PdfArray {
6471
private float lastNumber = float.NaN;
6572

itext/itext.kernel/itext/kernel/pdf/WriterProperties.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,6 @@ public virtual iText.Kernel.Pdf.WriterProperties SetFullCompressionMode(bool ful
190190
/// <see cref="EncryptionConstants.ALLOW_DEGRADED_PRINTING"/>
191191
/// .
192192
/// The permissions can be combined by ORing them.
193-
/// <p>
194193
/// </remarks>
195194
/// <param name="userPassword">the user password. Can be null or empty</param>
196195
/// <param name="ownerPassword">the owner password. Can be null or empty</param>
@@ -242,7 +241,6 @@ public virtual iText.Kernel.Pdf.WriterProperties SetStandardEncryption(byte[] us
242241
/// <see cref="EncryptionConstants.ALLOW_DEGRADED_PRINTING"/>
243242
/// .
244243
/// The permissions can be combined by ORing them.
245-
/// <p>
246244
/// </remarks>
247245
/// <param name="certs">the public certificates to be used for the encryption</param>
248246
/// <param name="permissions">the user permissions for each of the certificates</param>

itext/itext.kernel/itext/kernel/pdf/annot/BorderStyleUtil.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,19 @@ private BorderStyleUtil() {
5353
/// <ul>
5454
/// <li>
5555
/// <see cref="PdfAnnotation.STYLE_SOLID"/>
56-
/// - A solid rectangle surrounding the annotation.</li>
56+
/// - A solid rectangle surrounding the annotation.
5757
/// <li>
5858
/// <see cref="PdfAnnotation.STYLE_DASHED"/>
59-
/// - A dashed rectangle surrounding the annotation.</li>
59+
/// - A dashed rectangle surrounding the annotation.
6060
/// <li>
6161
/// <see cref="PdfAnnotation.STYLE_BEVELED"/>
62-
/// - A simulated embossed rectangle that appears to be raised above the surface of the page.</li>
62+
/// - A simulated embossed rectangle that appears to be raised above the surface of the page.
6363
/// <li>
6464
/// <see cref="PdfAnnotation.STYLE_INSET"/>
65-
/// - A simulated engraved rectangle that appears to be recessed below the surface of the page.</li>
65+
/// - A simulated engraved rectangle that appears to be recessed below the surface of the page.
6666
/// <li>
6767
/// <see cref="PdfAnnotation.STYLE_UNDERLINE"/>
68-
/// - A single line along the bottom of the annotation rectangle.</li>
68+
/// - A single line along the bottom of the annotation rectangle.
6969
/// </ul>
7070
/// See also ISO-320001, Table 166.
7171
/// </remarks>

itext/itext.kernel/itext/kernel/pdf/annot/PdfAnnotation.cs

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -696,57 +696,47 @@ public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetFlags(int flags) {
696696
/// - If set, do not display the annotation if it does not belong to one of the
697697
/// standard annotation types and no annotation handler is available. If clear, display such unknown annotation
698698
/// using an appearance stream specified by its appearance dictionary, if any.
699-
/// </li>
700699
/// <li>
701700
/// <see cref="HIDDEN"/>
702701
/// - If set, do not display or print the annotation or allow it to interact with
703702
/// the user, regardless of its annotation type or whether an annotation handler is available.
704-
/// </li>
705703
/// <li>
706704
/// <see cref="PRINT"/>
707705
/// - If set, print the annotation when the page is printed. If clear, never print
708706
/// the annotation, regardless of whether it is displayed on the screen.
709-
/// </li>
710707
/// <li>
711708
/// <see cref="NO_ZOOM"/>
712709
/// - If set, do not scale the annotation’s appearance to match the magnification of
713710
/// the page. The location of the annotation on the page (defined by the upper-left corner of its annotation
714711
/// rectangle) shall remain fixed, regardless of the page magnification.}
715-
/// </li>
716712
/// <li>
717713
/// <see cref="NO_ROTATE"/>
718714
/// - If set, do not rotate the annotation’s appearance to match the rotation
719715
/// of the page. The upper-left corner of the annotation rectangle shall remain in a fixed location on the page,
720716
/// regardless of the page rotation.
721-
/// </li>
722717
/// <li>
723718
/// <see cref="NO_VIEW"/>
724719
/// - If set, do not display the annotation on the screen or allow it to interact
725720
/// with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered
726721
/// hidden for purposes of on-screen display and user interaction.
727-
/// </li>
728722
/// <li>
729723
/// <see cref="READ_ONLY"/>
730724
/// - If set, do not allow the annotation to interact with the user. The annotation
731725
/// may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse
732726
/// clicks or change its appearance in response to mouse motions.
733-
/// </li>
734727
/// <li>
735728
/// <see cref="LOCKED"/>
736729
/// - If set, do not allow the annotation to be deleted or its properties
737730
/// (including position and size) to be modified by the user. However, this flag does not restrict changes to
738731
/// the annotation’s contents, such as the value of a form field.
739-
/// </li>
740732
/// <li>
741733
/// <see cref="TOGGLE_NO_VIEW"/>
742734
/// - If set, invert the interpretation of the NoView flag for certain events.
743-
/// </li>
744735
/// <li>
745736
/// <see cref="LOCKED_CONTENTS"/>
746737
/// - If set, do not allow the contents of the annotation to be modified
747738
/// by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties,
748739
/// such as position and size.
749-
/// </li>
750740
/// </ul>
751741
/// </remarks>
752742
/// <param name="flag">- an integer interpreted as set of one-bit flags which will be enabled for this annotation.
@@ -1149,12 +1139,8 @@ public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetAppearanceState(PdfName @
11491139
return Put(PdfName.AS, @as);
11501140
}
11511141

1152-
/// <summary>
1153-
/// <p>
1154-
/// An array specifying the characteristics of the annotation’s border.
1155-
/// </summary>
1142+
/// <summary>An array specifying the characteristics of the annotation’s border.</summary>
11561143
/// <remarks>
1157-
/// <p>
11581144
/// An array specifying the characteristics of the annotation’s border.
11591145
/// The array consists of three numbers defining the horizontal corner radius,
11601146
/// vertical corner radius, and border width, all in default user space units.
@@ -1211,16 +1197,16 @@ public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetBorder(PdfArray border) {
12111197
/// <summary>
12121198
/// An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes:
12131199
/// <ul>
1214-
/// <li>The background of the annotation’s icon when closed</li>
1215-
/// <li>The title bar of the annotation’s pop-up window</li>
1216-
/// <li>The border of a link annotation</li>
1200+
/// <li>The background of the annotation’s icon when closed
1201+
/// <li>The title bar of the annotation’s pop-up window
1202+
/// <li>The border of a link annotation
12171203
/// </ul>
12181204
/// The number of array elements determines the colour space in which the colour shall be defined:
12191205
/// <ul>
1220-
/// <li>0 - No colour; transparent</li>
1221-
/// <li>1 - DeviceGray</li>
1222-
/// <li>3 - DeviceRGB</li>
1223-
/// <li>4 - DeviceCMYK</li>
1206+
/// <li>0 - No colour; transparent
1207+
/// <li>1 - DeviceGray
1208+
/// <li>3 - DeviceRGB
1209+
/// <li>4 - DeviceCMYK
12241210
/// </ul>
12251211
/// </summary>
12261212
/// <returns>An array of numbers in the range 0.0 to 1.0, representing an annotation colour.</returns>

itext/itext.kernel/itext/kernel/pdf/annot/PdfCircleAnnotation.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,19 +112,19 @@ public virtual iText.Kernel.Pdf.Annot.PdfCircleAnnotation SetBorderStyle(PdfDict
112112
/// <ul>
113113
/// <li>
114114
/// <see cref="PdfAnnotation.STYLE_SOLID"/>
115-
/// - A solid rectangle surrounding the annotation.</li>
115+
/// - A solid rectangle surrounding the annotation.
116116
/// <li>
117117
/// <see cref="PdfAnnotation.STYLE_DASHED"/>
118-
/// - A dashed rectangle surrounding the annotation.</li>
118+
/// - A dashed rectangle surrounding the annotation.
119119
/// <li>
120120
/// <see cref="PdfAnnotation.STYLE_BEVELED"/>
121-
/// - A simulated embossed rectangle that appears to be raised above the surface of the page.</li>
121+
/// - A simulated embossed rectangle that appears to be raised above the surface of the page.
122122
/// <li>
123123
/// <see cref="PdfAnnotation.STYLE_INSET"/>
124-
/// - A simulated engraved rectangle that appears to be recessed below the surface of the page.</li>
124+
/// - A simulated engraved rectangle that appears to be recessed below the surface of the page.
125125
/// <li>
126126
/// <see cref="PdfAnnotation.STYLE_UNDERLINE"/>
127-
/// - A single line along the bottom of the annotation rectangle.</li>
127+
/// - A single line along the bottom of the annotation rectangle.
128128
/// </ul>
129129
/// See also ISO-320001, Table 166.
130130
/// </remarks>

0 commit comments

Comments
 (0)