Skip to content

Commit 739c74f

Browse files
committed
Improve itextcore's javadocs.
Do not use paragraph's end tags for separation reasons in Javadoc. Javadoc isn't xml-based. It has its own markdown. The changes have been inplemented during the third technical-debt session. DEVSIX-3096 Autoported commit. Original commit hash: [dbc6439b9] Manual files: io/src/main/java/com/itextpdf/io/codec/Base64.java layout/src/main/java/com/itextpdf/layout/hyphenation/PatternParser.java styled-xml-parser/src/main/java/com/itextpdf/styledxmlparser/jsoup/nodes/Attributes.java styled-xml-parser/src/main/java/com/itextpdf/styledxmlparser/jsoup/select/Elements.java
1 parent 6c0ffdb commit 739c74f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+246
-375
lines changed

itext/itext.barcodes/itext/barcodes/qrcode/BitArray.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ source product.
4545
using System.Text;
4646

4747
namespace iText.Barcodes.Qrcode {
48-
/// <summary><p>A simple, fast array of bits, represented compactly by an array of ints internally.</p></summary>
48+
/// <summary>A simple, fast array of bits, represented compactly by an array of ints internally.</summary>
4949
/// <author>Sean Owen</author>
5050
internal sealed class BitArray {
5151
private int[] bits;

itext/itext.barcodes/itext/barcodes/qrcode/BitMatrix.cs

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,18 @@ source product.
4545
using System.Text;
4646

4747
namespace iText.Barcodes.Qrcode {
48-
/// <summary><p>Represents a 2D matrix of bits.</summary>
48+
/// <summary>Represents a 2D matrix of bits.</summary>
4949
/// <remarks>
50-
/// <p>Represents a 2D matrix of bits. In function arguments below, and throughout the common
50+
/// Represents a 2D matrix of bits. In function arguments below, and throughout the common
5151
/// module, x is the column position, and y is the row position. The ordering is always x, y.
52-
/// The origin is at the top-left.</p>
53-
/// <p>Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins
52+
/// The origin is at the top-left.
53+
/// <p>
54+
/// Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins
5455
/// with a new int. This is done intentionally so that we can copy out a row into a BitArray very
55-
/// efficiently.</p>
56-
/// <p>The ordering of bits is row-major. Within each int, the least significant bits are used first,
57-
/// meaning they represent lower x values. This is compatible with BitArray's implementation.</p>
56+
/// efficiently.
57+
/// <p>
58+
/// The ordering of bits is row-major. Within each int, the least significant bits are used first,
59+
/// meaning they represent lower x values. This is compatible with BitArray's implementation.
5860
/// </remarks>
5961
/// <author>Sean Owen</author>
6062
/// <author>[email protected] (Daniel Switkin)</author>
@@ -86,7 +88,7 @@ public BitMatrix(int width, int height) {
8688
bits = new int[rowSize * height];
8789
}
8890

89-
/// <summary><p>Gets the requested bit, where true means black.</p></summary>
91+
/// <summary>Gets the requested bit, where true means black.</summary>
9092
/// <param name="x">The horizontal component (i.e. which column)</param>
9193
/// <param name="y">The vertical component (i.e. which row)</param>
9294
/// <returns>value of given bit in matrix</returns>
@@ -95,15 +97,15 @@ public bool Get(int x, int y) {
9597
return (((int)(((uint)bits[offset]) >> (x & 0x1f))) & 1) != 0;
9698
}
9799

98-
/// <summary><p>Sets the given bit to true.</p></summary>
100+
/// <summary>Sets the given bit to true.</summary>
99101
/// <param name="x">The horizontal component (i.e. which column)</param>
100102
/// <param name="y">The vertical component (i.e. which row)</param>
101103
public void Set(int x, int y) {
102104
int offset = y * rowSize + (x >> 5);
103105
bits[offset] |= 1 << (x & 0x1f);
104106
}
105107

106-
/// <summary><p>Flips the given bit.</p></summary>
108+
/// <summary>Flips the given bit.</summary>
107109
/// <param name="x">The horizontal component (i.e. which column)</param>
108110
/// <param name="y">The vertical component (i.e. which row)</param>
109111
public void Flip(int x, int y) {
@@ -119,7 +121,7 @@ public void Clear() {
119121
}
120122
}
121123

122-
/// <summary><p>Sets a square region of the bit matrix to true.</p></summary>
124+
/// <summary>Sets a square region of the bit matrix to true.</summary>
123125
/// <param name="left">The horizontal position to begin at (inclusive)</param>
124126
/// <param name="top">The vertical position to begin at (inclusive)</param>
125127
/// <param name="width">The width of the region</param>

itext/itext.barcodes/itext/barcodes/qrcode/ErrorCorrectionLevel.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ source product.
4444
using System;
4545

4646
namespace iText.Barcodes.Qrcode {
47-
/// <summary><p>See ISO 18004:2006, 6.5.1.</summary>
47+
/// <summary>See ISO 18004:2006, 6.5.1.</summary>
4848
/// <remarks>
49-
/// <p>See ISO 18004:2006, 6.5.1. This enum encapsulates the four error correction levels
50-
/// defined by the QR code standard.</p>
49+
/// See ISO 18004:2006, 6.5.1. This enum encapsulates the four error correction levels
50+
/// defined by the QR code standard.
5151
/// </remarks>
5252
/// <author>Sean Owen</author>
5353
public sealed class ErrorCorrectionLevel {

itext/itext.barcodes/itext/barcodes/qrcode/FormatInformation.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ source product.
4545

4646
namespace iText.Barcodes.Qrcode {
4747
/// <summary>
48-
/// <p>Encapsulates a QR Code's format information, including the data mask used and
49-
/// error correction level.</p>
48+
/// Encapsulates a QR Code's format information, including the data mask used and
49+
/// error correction level.
5050
/// </summary>
5151
/// <author>Sean Owen</author>
5252
/// <seealso cref="ErrorCorrectionLevel"/>

itext/itext.barcodes/itext/barcodes/qrcode/GF256.cs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,16 @@ source product.
4545

4646
namespace iText.Barcodes.Qrcode {
4747
/// <summary>
48-
/// <p>This class contains utility methods for performing mathematical operations over
48+
/// This class contains utility methods for performing mathematical operations over
4949
/// the Galois Field GF(256).
5050
/// </summary>
5151
/// <remarks>
52-
/// <p>This class contains utility methods for performing mathematical operations over
53-
/// the Galois Field GF(256). Operations use a given primitive polynomial in calculations.</p>
54-
/// <p>Throughout this package, elements of GF(256) are represented as an <code>int</code>
52+
/// This class contains utility methods for performing mathematical operations over
53+
/// the Galois Field GF(256). Operations use a given primitive polynomial in calculations.
54+
/// <p>
55+
/// Throughout this package, elements of GF(256) are represented as an <code>int</code>
5556
/// for convenience and speed (but at the cost of memory).
56-
/// Only the bottom 8 bits are really used.</p>
57+
/// Only the bottom 8 bits are really used.
5758
/// </remarks>
5859
/// <author>Sean Owen</author>
5960
internal sealed class GF256 {

itext/itext.barcodes/itext/barcodes/qrcode/GF256Poly.cs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,13 @@ source product.
4545
using System.Text;
4646

4747
namespace iText.Barcodes.Qrcode {
48-
/// <summary><p>Represents a polynomial whose coefficients are elements of GF(256).</summary>
48+
/// <summary>Represents a polynomial whose coefficients are elements of GF(256).</summary>
4949
/// <remarks>
50-
/// <p>Represents a polynomial whose coefficients are elements of GF(256).
51-
/// Instances of this class are immutable.</p>
52-
/// <p>Much credit is due to William Rucklidge since portions of this code are an indirect
53-
/// port of his C++ Reed-Solomon implementation.</p>
50+
/// Represents a polynomial whose coefficients are elements of GF(256).
51+
/// Instances of this class are immutable.
52+
/// <p>
53+
/// Much credit is due to William Rucklidge since portions of this code are an indirect
54+
/// port of his C++ Reed-Solomon implementation.
5455
/// </remarks>
5556
/// <author>Sean Owen</author>
5657
internal sealed class GF256Poly {

itext/itext.barcodes/itext/barcodes/qrcode/Mode.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ source product.
4444
using System;
4545

4646
namespace iText.Barcodes.Qrcode {
47-
/// <summary><p>See ISO 18004:2006, 6.4.1, Tables 2 and 3.</summary>
47+
/// <summary>See ISO 18004:2006, 6.4.1, Tables 2 and 3.</summary>
4848
/// <remarks>
49-
/// <p>See ISO 18004:2006, 6.4.1, Tables 2 and 3. This enum encapsulates the various modes in which
50-
/// data can be encoded to bits in the QR code standard.</p>
49+
/// See ISO 18004:2006, 6.4.1, Tables 2 and 3. This enum encapsulates the various modes in which
50+
/// data can be encoded to bits in the QR code standard.
5151
/// </remarks>
5252
/// <author>Sean Owen</author>
5353
internal sealed class Mode {

itext/itext.barcodes/itext/barcodes/qrcode/ReedSolomonEncoder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ source product.
4545
using System.Collections.Generic;
4646

4747
namespace iText.Barcodes.Qrcode {
48-
/// <summary><p>Implements Reed-Solomon encoding, as the name implies.</p></summary>
48+
/// <summary>Implements Reed-Solomon encoding, as the name implies.</summary>
4949
/// <author>Sean Owen</author>
5050
/// <author>William Rucklidge</author>
5151
internal sealed class ReedSolomonEncoder {

itext/itext.barcodes/itext/barcodes/qrcode/ReedSolomonException.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ source product.
4545

4646
namespace iText.Barcodes.Qrcode {
4747
/// <summary>
48-
/// <p>Thrown when an exception occurs during Reed-Solomon decoding, such as when
49-
/// there are too many errors to correct.</p>
48+
/// Thrown when an exception occurs during Reed-Solomon decoding, such as when
49+
/// there are too many errors to correct.
5050
/// </summary>
5151
/// <author>Sean Owen</author>
5252
internal sealed class ReedSolomonException : Exception {

itext/itext.barcodes/itext/barcodes/qrcode/Version.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public Version.ECBlocks GetECBlocksForLevel(ErrorCorrectionLevel ecLevel) {
109109
return ecBlocks[ecLevel.Ordinal()];
110110
}
111111

112-
/// <summary><p>Deduces version information purely from QR Code dimensions.</p></summary>
112+
/// <summary>Deduces version information purely from QR Code dimensions.</summary>
113113
/// <param name="dimension">dimension in modules</param>
114114
/// <returns>
115115
///
@@ -202,12 +202,12 @@ internal BitMatrix BuildFunctionPattern() {
202202
return bitMatrix;
203203
}
204204

205-
/// <summary><p>Encapsulates a set of error-correction blocks in one symbol version.</summary>
205+
/// <summary>Encapsulates a set of error-correction blocks in one symbol version.</summary>
206206
/// <remarks>
207-
/// <p>Encapsulates a set of error-correction blocks in one symbol version. Most versions will
207+
/// Encapsulates a set of error-correction blocks in one symbol version. Most versions will
208208
/// use blocks of differing sizes within one version, so, this encapsulates the parameters for
209209
/// each set of blocks. It also holds the number of error-correction codewords per block since it
210-
/// will be the same across all blocks within one version.</p>
210+
/// will be the same across all blocks within one version.
211211
/// </remarks>
212212
public sealed class ECBlocks {
213213
private readonly int ecCodewordsPerBlock;
@@ -247,11 +247,11 @@ public Version.ECB[] GetECBlocks() {
247247
}
248248
}
249249

250-
/// <summary><p>Encapsualtes the parameters for one error-correction block in one symbol version.</summary>
250+
/// <summary>Encapsualtes the parameters for one error-correction block in one symbol version.</summary>
251251
/// <remarks>
252-
/// <p>Encapsualtes the parameters for one error-correction block in one symbol version.
252+
/// Encapsualtes the parameters for one error-correction block in one symbol version.
253253
/// This includes the number of data codewords, and the number of times a block with these
254-
/// parameters is used consecutively in the QR code version's format.</p>
254+
/// parameters is used consecutively in the QR code version's format.
255255
/// </remarks>
256256
public sealed class ECB {
257257
private readonly int count;

0 commit comments

Comments
 (0)