Skip to content

Commit 987e3ef

Browse files
author
Joris Schellekens
committed
DEVSIX-1460
fix javadoc errors
1 parent ba96033 commit 987e3ef

File tree

116 files changed

+673
-478
lines changed

Some content is hidden

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

116 files changed

+673
-478
lines changed

‎barcodes/src/main/java/com/itextpdf/barcodes/Barcode128.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,7 @@ public class Barcode128 extends Barcode1D {
222222

223223
/**
224224
* Creates new Barcode128
225+
* @param document The document
225226
*/
226227
public Barcode128(PdfDocument document) {
227228
super(document);
@@ -252,8 +253,8 @@ public Barcode128CodeSet getCodeSet() {
252253

253254
/**
254255
* Removes the FNC1 codes in the text.
255-
* @param code the text to clean
256-
* @return the cleaned text
256+
* @param code The text to clean
257+
* @return The cleaned text
257258
*/
258259
public static String removeFNC1(String code) {
259260
int len = code.length();
@@ -531,8 +532,9 @@ public Rectangle getBarcodeSize() {
531532
* Places the barcode in a <CODE>PdfCanvas</CODE>. The
532533
* barcode is always placed at coordinates (0, 0). Use the
533534
* translation matrix to move it elsewhere.<p>
534-
* The bars and text are written in the following colors:<p>
535-
* <P><TABLE BORDER=1>
535+
* The bars and text are written in the following colors:
536+
* <br>
537+
* <TABLE BORDER=1 SUMMARY="barcode properties">
536538
* <TR>
537539
* <TH><P><CODE>barColor</CODE></TH>
538540
* <TH><P><CODE>textColor</CODE></TH>
@@ -656,7 +658,7 @@ public Rectangle placeBarcode(PdfCanvas canvas, Color barColor, Color textColor)
656658
/**
657659
* Sets the code to generate. If it's an UCC code and starts with '(' it will
658660
* be split by the AI. This code in UCC mode is valid:
659-
* <p/>
661+
* <br>
660662
* <code>(01)00000090311314(10)ABC123(15)060916</code>
661663
*
662664
* @param code the code to generate

‎barcodes/src/main/java/com/itextpdf/barcodes/Barcode1D.java

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -422,8 +422,9 @@ public void setCodeType(int codeType) {
422422
* Places the barcode in a <CODE>PdfCanvas</CODE>. The
423423
* barcode is always placed at coordinates (0, 0). Use the
424424
* translation matrix to move it elsewhere.<p>
425-
* The bars and text are written in the following colors:<p>
426-
* <P><TABLE BORDER=1>
425+
* The bars and text are written in the following colors:
426+
* <br>
427+
* <TABLE BORDER=1 SUMMARY="barcode properties">
427428
* <TR>
428429
* <TH><P><CODE>barColor</CODE></TH>
429430
* <TH><P><CODE>textColor</CODE></TH>
@@ -509,8 +510,8 @@ public void setAltText(String altText) {
509510

510511
/**
511512
* Creates a PdfFormXObject with the barcode. Default bar color and text color will be used.
512-
*
513-
* @return the XObject
513+
* @param document The document
514+
* @return The XObject
514515
* @see #createFormXObject(Color, Color, PdfDocument)
515516
*/
516517
public PdfFormXObject createFormXObject(PdfDocument document) {
@@ -520,8 +521,9 @@ public PdfFormXObject createFormXObject(PdfDocument document) {
520521
/**
521522
* Creates a PdfFormXObject with the barcode.
522523
*
523-
* @param barColor the color of the bars. It can be <CODE>null</CODE>
524-
* @param textColor the color of the text. It can be <CODE>null</CODE>
524+
* @param barColor The color of the bars. It can be <CODE>null</CODE>
525+
* @param textColor The color of the text. It can be <CODE>null</CODE>
526+
* @param document The document
525527
* @return the XObject
526528
* @see #placeBarcode(PdfCanvas canvas, Color barColor, Color textColor)
527529
*/
@@ -536,6 +538,7 @@ public PdfFormXObject createFormXObject(Color barColor, Color textColor, PdfDocu
536538
/**
537539
* Make the barcode occupy the specified width.
538540
* Usually this is achieved by adjusting bar widths.
541+
* @param width The width
539542
*/
540543
public void fitWidth(float width) {
541544
setX(x * width / getBarcodeSize().getWidth());

‎barcodes/src/main/java/com/itextpdf/barcodes/Barcode2D.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ public abstract class Barcode2D {
7676
* Creates a PdfFormXObject with the barcode.
7777
* Default foreground color will be used.
7878
*
79+
* @param document The document
7980
* @return the XObject.
8081
*/
8182
public PdfFormXObject createFormXObject(PdfDocument document) {
@@ -85,7 +86,8 @@ public PdfFormXObject createFormXObject(PdfDocument document) {
8586
/**
8687
* Creates a PdfFormXObject with the barcode.
8788
*
88-
* @param foreground the color of the pixels. It can be <CODE>null</CODE>
89+
* @param foreground The color of the pixels. It can be <CODE>null</CODE>
90+
* @param document The document
8991
* @return the XObject.
9092
*/
9193
public abstract PdfFormXObject createFormXObject(Color foreground, PdfDocument document);

‎barcodes/src/main/java/com/itextpdf/barcodes/Barcode39.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ public class Barcode39 extends Barcode1D {
130130

131131
/**
132132
* Creates a new Barcode39.
133+
* @param document The document
133134
*/
134135
public Barcode39(PdfDocument document) {
135136
super(document);
@@ -258,8 +259,9 @@ public Rectangle getBarcodeSize() {
258259
* Places the barcode in a <CODE>PdfCanvas</CODE>. The
259260
* barcode is always placed at coordinates (0, 0). Use the
260261
* translation matrix to move it elsewhere.<p>
261-
* The bars and text are written in the following colors:<p>
262-
* <P><TABLE BORDER=1>
262+
* The bars and text are written in the following colors:
263+
* <br>
264+
* <TABLE BORDER=1 SUMMARY="barcode properties">
263265
* <TR>
264266
* <TH><P><CODE>barColor</CODE></TH>
265267
* <TH><P><CODE>textColor</CODE></TH>

‎barcodes/src/main/java/com/itextpdf/barcodes/BarcodeCodabar.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ public class BarcodeCodabar extends Barcode1D {
9090

9191
/**
9292
* Creates a new BarcodeCodabar.
93+
* @param document The document
9394
*/
9495
public BarcodeCodabar(PdfDocument document) {
9596
super(document);
@@ -191,8 +192,9 @@ public Rectangle getBarcodeSize() {
191192
* Places the barcode in a <CODE>PdfCanvas</CODE>. The
192193
* barcode is always placed at coordinates (0, 0). Use the
193194
* translation matrix to move it elsewhere.<p>
194-
* The bars and text are written in the following colors:<p>
195-
* <P><TABLE BORDER=1>
195+
* The bars and text are written in the following colors:
196+
* <br>
197+
* <TABLE BORDER=1 SUMMARY="barcode properties">
196198
* <TR>
197199
* <TH><P><CODE>barColor</CODE></TH>
198200
* <TH><P><CODE>textColor</CODE></TH>

‎barcodes/src/main/java/com/itextpdf/barcodes/BarcodeDataMatrix.java

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,9 @@ public PdfFormXObject createFormXObject(Color foreground, PdfDocument document)
225225
/**
226226
* Creates a PdfFormXObject with the barcode with given module width and module height.
227227
*
228-
* @param foreground the color of the pixels. It can be <CODE>null</CODE>
229-
* @param moduleSide the side (width and height) of the pixels.
228+
* @param foreground The color of the pixels. It can be <CODE>null</CODE>
229+
* @param moduleSide The side (width and height) of the pixels.
230+
* @param document The document
230231
* @return the XObject.
231232
*/
232233
public PdfFormXObject createFormXObject(Color foreground, float moduleSide, PdfDocument document) {
@@ -302,6 +303,9 @@ public java.awt.Image createAwtImage(java.awt.Color foreground, java.awt.Color b
302303

303304
/**
304305
* Gets the barcode size
306+
* @param moduleHeight The height of the module
307+
* @param moduleWidth The width of the module
308+
* @return The size of the barcode
305309
*/
306310
public Rectangle getBarcodeSize(float moduleHeight, float moduleWidth) {
307311
return new Rectangle(0, 0, (width + 2 * ws) * moduleHeight, (height + 2 * ws) * moduleWidth);
@@ -312,7 +316,7 @@ public Rectangle getBarcodeSize(float moduleHeight, float moduleWidth) {
312316
*
313317
* @param text the text
314318
* @return the status of the generation. It can be one of this values:
315-
* <p/>
319+
*
316320
* <CODE>DM_NO_ERROR</CODE> - no error.<br>
317321
* <CODE>DM_ERROR_TEXT_TOO_BIG</CODE> - the text is too big for the symbology capabilities.<br>
318322
* <CODE>DM_ERROR_INVALID_SQUARE</CODE> - the dimensions given for the symbol are illegal.<br>
@@ -335,7 +339,7 @@ public int setCode(String text) {
335339
* @param textOffset the offset to the start of the text
336340
* @param textSize the text size
337341
* @return the status of the generation. It can be one of this values:
338-
* <p/>
342+
*
339343
* <CODE>DM_NO_ERROR</CODE> - no error.<br>
340344
* <CODE>DM_ERROR_TEXT_TOO_BIG</CODE> - the text is too big for the symbology capabilities.<br>
341345
* <CODE>DM_ERROR_INVALID_SQUARE</CODE> - the dimensions given for the symbol are illegal.<br>
@@ -406,7 +410,7 @@ public int getHeight() {
406410

407411
/**
408412
* Sets the height of the barcode. If the height is zero it will be calculated. This height doesn't include the whitespace border, if any.
409-
* <p/>
413+
*
410414
* The allowed dimensions are (height, width):<p>
411415
* 10, 10<br>
412416
* 12, 12<br>
@@ -457,7 +461,7 @@ public int getWidth() {
457461

458462
/**
459463
* Sets the width of the barcode. If the width is zero it will be calculated. This width doesn't include the whitespace border, if any.
460-
* <p/>
464+
*
461465
* The allowed dimensions are (height, width):<p>
462466
* 10, 10<br>
463467
* 12, 12<br>
@@ -535,7 +539,7 @@ public int getOptions() {
535539
* <CODE>DM_X12</CODE> - X12 encodation<br>
536540
* <CODE>DM_EDIFACT</CODE> - EDIFACT encodation<br>
537541
* <CODE>DM_RAW</CODE> - no encodation. The bytes provided are already encoded and will be added directly to the barcode, using padding if needed. It assumes that the encodation state is left at ASCII after the last byte.<br>
538-
* <p/>
542+
* <br>
539543
* One of:<br>
540544
* <CODE>DM_EXTENSION</CODE> - allows extensions to be embedded at the start of the text:<p>
541545
* exxxxxx - ECI number xxxxxx<br>

‎barcodes/src/main/java/com/itextpdf/barcodes/BarcodeEAN.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ public class BarcodeEAN extends Barcode1D {
208208

209209
/**
210210
* Creates new BarcodeEAN
211+
* @param document The document
211212
*/
212213
public BarcodeEAN(PdfDocument document) {
213214
super(document);
@@ -541,8 +542,9 @@ public Rectangle getBarcodeSize() {
541542
* Places the barcode in a <CODE>PdfCanvas</CODE>. The
542543
* barcode is always placed at coordinates (0, 0). Use the
543544
* translation matrix to move it elsewhere.<p>
544-
* The bars and text are written in the following colors:<p>
545-
* <P><TABLE BORDER=1>
545+
* The bars and text are written in the following colors:
546+
* <br>
547+
* <TABLE BORDER=1 SUMMARY="barcode properties">
546548
* <TR>
547549
* <TH><P><CODE>barColor</CODE></TH>
548550
* <TH><P><CODE>textColor</CODE></TH>

‎barcodes/src/main/java/com/itextpdf/barcodes/BarcodeEANSUPP.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@ public Rectangle getBarcodeSize() {
9191
* Places the barcode in a <CODE>PdfCanvas</CODE>. The
9292
* barcode is always placed at coordinates (0, 0). Use the
9393
* translation matrix to move it elsewhere.<p>
94-
* The bars and text are written in the following colors:<p>
95-
* <P><TABLE BORDER=1>
94+
* The bars and text are written in the following colors:
95+
* <br>
96+
* <TABLE BORDER=1 SUMMARY="barcode properties">
9697
* <TR>
9798
* <TH><P><CODE>barColor</CODE></TH>
9899
* <TH><P><CODE>textColor</CODE></TH>

‎barcodes/src/main/java/com/itextpdf/barcodes/BarcodeInter25.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ public class BarcodeInter25 extends Barcode1D {
9494

9595
/**
9696
* Creates new BarcodeInter25
97+
* @param document The document
9798
*/
9899
public BarcodeInter25(PdfDocument document) {
99100
super(document);
@@ -213,8 +214,9 @@ public Rectangle getBarcodeSize() {
213214
* Places the barcode in a <CODE>PdfCanvas</CODE>. The
214215
* barcode is always placed at coordinates (0, 0). Use the
215216
* translation matrix to move it elsewhere.<p>
216-
* The bars and text are written in the following colors:<p>
217-
* <P><TABLE BORDER=1>
217+
* The bars and text are written in the following colors:
218+
* <br>
219+
* <TABLE BORDER=1 SUMMARY="barcode properties">
218220
* <TR>
219221
* <TH><P><CODE>barColor</CODE></TH>
220222
* <TH><P><CODE>textColor</CODE></TH>

‎barcodes/src/main/java/com/itextpdf/barcodes/BarcodePDF417.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -847,9 +847,10 @@ public PdfFormXObject createFormXObject(Color foreground, PdfDocument document)
847847
/**
848848
* Creates a PdfFormXObject with the barcode with given module width and module height.
849849
*
850-
* @param foreground the color of the pixels. It can be <CODE>null</CODE>
851-
* @param moduleWidth the width of the pixels.
852-
* @param moduleHeight the height of the pixels.
850+
* @param foreground The color of the pixels. It can be <CODE>null</CODE>
851+
* @param moduleWidth The width of the pixels.
852+
* @param moduleHeight The height of the pixels.
853+
* @param document The document
853854
* @return the XObject.
854855
*/
855856
public PdfFormXObject createFormXObject(Color foreground, float moduleWidth, float moduleHeight, PdfDocument document) {

0 commit comments

Comments
 (0)