Skip to content

Commit dbc6439

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
1 parent 87048ca commit dbc6439

File tree

73 files changed

+495
-547
lines changed

Some content is hidden

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

73 files changed

+495
-547
lines changed

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/BitArray.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ This file is part of the iText (R) project.
4545

4646

4747
/**
48-
* <p>A simple, fast array of bits, represented compactly by an array of ints internally.</p>
48+
* A simple, fast array of bits, represented compactly by an array of ints internally.
49+
*
4950
* @author Sean Owen
5051
*/
5152
final class BitArray {

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/BitMatrix.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,16 @@ This file is part of the iText (R) project.
4444
package com.itextpdf.barcodes.qrcode;
4545

4646
/**
47-
* <p>Represents a 2D matrix of bits. In function arguments below, and throughout the common
47+
* Represents a 2D matrix of bits. In function arguments below, and throughout the common
4848
* module, x is the column position, and y is the row position. The ordering is always x, y.
49-
* The origin is at the top-left.</p>
50-
*
51-
* <p>Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins
49+
* The origin is at the top-left.
50+
* <p>
51+
* Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins
5252
* with a new int. This is done intentionally so that we can copy out a row into a BitArray very
53-
* efficiently.</p>
54-
*
55-
* <p>The ordering of bits is row-major. Within each int, the least significant bits are used first,
56-
* meaning they represent lower x values. This is compatible with BitArray's implementation.</p>
53+
* efficiently.
54+
* <p>
55+
* The ordering of bits is row-major. Within each int, the least significant bits are used first,
56+
* meaning they represent lower x values. This is compatible with BitArray's implementation.
5757
*
5858
* @author Sean Owen
5959
* @author [email protected] (Daniel Switkin)
@@ -85,7 +85,7 @@ public BitMatrix(int width, int height) {
8585
}
8686

8787
/**
88-
* <p>Gets the requested bit, where true means black.</p>
88+
* Gets the requested bit, where true means black.
8989
*
9090
* @param x The horizontal component (i.e. which column)
9191
* @param y The vertical component (i.e. which row)
@@ -97,7 +97,7 @@ public boolean get(int x, int y) {
9797
}
9898

9999
/**
100-
* <p>Sets the given bit to true.</p>
100+
* Sets the given bit to true.
101101
*
102102
* @param x The horizontal component (i.e. which column)
103103
* @param y The vertical component (i.e. which row)
@@ -108,7 +108,7 @@ public void set(int x, int y) {
108108
}
109109

110110
/**
111-
* <p>Flips the given bit.</p>
111+
* Flips the given bit.
112112
*
113113
* @param x The horizontal component (i.e. which column)
114114
* @param y The vertical component (i.e. which row)
@@ -129,7 +129,7 @@ public void clear() {
129129
}
130130

131131
/**
132-
* <p>Sets a square region of the bit matrix to true.</p>
132+
* Sets a square region of the bit matrix to true.
133133
*
134134
* @param left The horizontal position to begin at (inclusive)
135135
* @param top The vertical position to begin at (inclusive)

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/ErrorCorrectionLevel.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ This file is part of the iText (R) project.
4444
package com.itextpdf.barcodes.qrcode;
4545

4646
/**
47-
* <p>See ISO 18004:2006, 6.5.1. This enum encapsulates the four error correction levels
48-
* defined by the QR code standard.</p>
47+
* See ISO 18004:2006, 6.5.1. This enum encapsulates the four error correction levels
48+
* defined by the QR code standard.
4949
*
5050
* @author Sean Owen
5151
*/

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/FormatInformation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ This file is part of the iText (R) project.
4444
package com.itextpdf.barcodes.qrcode;
4545

4646
/**
47-
* <p>Encapsulates a QR Code's format information, including the data mask used and
48-
* error correction level.</p>
47+
* Encapsulates a QR Code's format information, including the data mask used and
48+
* error correction level.
4949
*
5050
* @author Sean Owen
5151
* @see ErrorCorrectionLevel

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/GF256.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ This file is part of the iText (R) project.
4444
package com.itextpdf.barcodes.qrcode;
4545

4646
/**
47-
* <p>This class contains utility methods for performing mathematical operations over
48-
* the Galois Field GF(256). Operations use a given primitive polynomial in calculations.</p>
49-
*
50-
* <p>Throughout this package, elements of GF(256) are represented as an <code>int</code>
47+
* This class contains utility methods for performing mathematical operations over
48+
* the Galois Field GF(256). Operations use a given primitive polynomial in calculations.
49+
* <p>
50+
* Throughout this package, elements of GF(256) are represented as an <code>int</code>
5151
* for convenience and speed (but at the cost of memory).
52-
* Only the bottom 8 bits are really used.</p>
52+
* Only the bottom 8 bits are really used.
5353
*
5454
* @author Sean Owen
5555
*/

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/GF256Poly.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ This file is part of the iText (R) project.
4444
package com.itextpdf.barcodes.qrcode;
4545

4646
/**
47-
* <p>Represents a polynomial whose coefficients are elements of GF(256).
48-
* Instances of this class are immutable.</p>
49-
*
50-
* <p>Much credit is due to William Rucklidge since portions of this code are an indirect
51-
* port of his C++ Reed-Solomon implementation.</p>
47+
* Represents a polynomial whose coefficients are elements of GF(256).
48+
* Instances of this class are immutable.
49+
* <p>
50+
* Much credit is due to William Rucklidge since portions of this code are an indirect
51+
* port of his C++ Reed-Solomon implementation.
5252
*
5353
* @author Sean Owen
5454
*/

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/Mode.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ This file is part of the iText (R) project.
4444
package com.itextpdf.barcodes.qrcode;
4545

4646
/**
47-
* <p>See ISO 18004:2006, 6.4.1, Tables 2 and 3. This enum encapsulates the various modes in which
48-
* data can be encoded to bits in the QR code standard.</p>
47+
* See ISO 18004:2006, 6.4.1, Tables 2 and 3. This enum encapsulates the various modes in which
48+
* data can be encoded to bits in the QR code standard.
4949
*
5050
* @author Sean Owen
5151
*/

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/ReedSolomonEncoder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ This file is part of the iText (R) project.
4747
import java.util.List;
4848

4949
/**
50-
* <p>Implements Reed-Solomon encoding, as the name implies.</p>
50+
* Implements Reed-Solomon encoding, as the name implies.
5151
*
5252
* @author Sean Owen
5353
* @author William Rucklidge

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/ReedSolomonException.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ This file is part of the iText (R) project.
4444
package com.itextpdf.barcodes.qrcode;
4545

4646
/**
47-
* <p>Thrown when an exception occurs during Reed-Solomon decoding, such as when
48-
* there are too many errors to correct.</p>
47+
* Thrown when an exception occurs during Reed-Solomon decoding, such as when
48+
* there are too many errors to correct.
4949
*
5050
* @author Sean Owen
5151
*/

barcodes/src/main/java/com/itextpdf/barcodes/qrcode/Version.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ public ECBlocks getECBlocksForLevel(ErrorCorrectionLevel ecLevel) {
129129
}
130130

131131
/**
132-
* <p>Deduces version information purely from QR Code dimensions.</p>
132+
* Deduces version information purely from QR Code dimensions.
133133
*
134134
* @param dimension dimension in modules
135135
* @return {@link Version} for a QR Code of that dimension
@@ -231,10 +231,10 @@ BitMatrix buildFunctionPattern() {
231231
}
232232

233233
/**
234-
* <p>Encapsulates a set of error-correction blocks in one symbol version. Most versions will
234+
* Encapsulates a set of error-correction blocks in one symbol version. Most versions will
235235
* use blocks of differing sizes within one version, so, this encapsulates the parameters for
236236
* each set of blocks. It also holds the number of error-correction codewords per block since it
237-
* will be the same across all blocks within one version.</p>
237+
* will be the same across all blocks within one version.
238238
*/
239239
public static final class ECBlocks {
240240
private final int ecCodewordsPerBlock;
@@ -278,9 +278,9 @@ public ECB[] getECBlocks() {
278278
}
279279

280280
/**
281-
* <p>Encapsualtes the parameters for one error-correction block in one symbol version.
281+
* Encapsualtes the parameters for one error-correction block in one symbol version.
282282
* This includes the number of data codewords, and the number of times a block with these
283-
* parameters is used consecutively in the QR code version's format.</p>
283+
* parameters is used consecutively in the QR code version's format.
284284
*/
285285
public static final class ECB {
286286
private final int count;

0 commit comments

Comments
 (0)