Skip to content

Commit f9dad71

Browse files
Artyom YanchevskyiText-CI
authored andcommitted
Fix javadoc warnings
DEVSIX-4824
1 parent 8f65d46 commit f9dad71

File tree

4 files changed

+47
-25
lines changed

4 files changed

+47
-25
lines changed

kernel/src/main/java/com/itextpdf/kernel/geom/Matrix.java

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,14 @@ public class Matrix implements Serializable {
7272
public static final int I33 = 8;
7373
private static final long serialVersionUID = 7434885566068528477L;
7474

75-
/** the values inside the matrix (the identity matrix by default).
76-
* <p>For reference, the indeces are as follows:<p>
77-
* I11 I12 I13<p>
78-
* I21 I22 I23<p>
79-
* I31 I32 I33<p>
75+
/**
76+
* The values inside the matrix (the identity matrix by default).
77+
*
78+
* <p>
79+
* For reference, the indeces are as follows:
80+
* <br>I11 I12 I13
81+
* <br>I21 I22 I23
82+
* <br>I31 I32 I33
8083
*/
8184
private final float[] vals = new float[]{
8285
1,0,0,
@@ -91,7 +94,8 @@ public Matrix() {
9194
}
9295

9396
/**
94-
* Constructs a matrix that represents translation
97+
* Constructs a matrix that represents translation.
98+
*
9599
* @param tx x-axis translation
96100
* @param ty y-axis translation
97101
*/
@@ -101,7 +105,8 @@ public Matrix(float tx, float ty) {
101105
}
102106

103107
/**
104-
* Creates a Matrix with 9 specified entries
108+
* Creates a Matrix with 9 specified entries.
109+
*
105110
* @param e11 element at position (1,1)
106111
* @param e12 element at position (1,2)
107112
* @param e13 element at position (1,3)
@@ -125,9 +130,10 @@ public Matrix(float e11, float e12, float e13, float e21, float e22, float e23,
125130
}
126131

127132
/**
128-
* Creates a Matrix with 6 specified entries
133+
* Creates a Matrix with 6 specified entries.
129134
* The third column will always be [0 0 1]
130135
* (row, column)
136+
*
131137
* @param a element at (1,1)
132138
* @param b element at (1,2)
133139
* @param c element at (2,1)
@@ -150,23 +156,25 @@ public Matrix(float a, float b, float c, float d, float e, float f){
150156
/**
151157
* Gets a specific value inside the matrix.
152158
*
153-
* <p>For reference, the indeces are as follows:<p>
154-
* I11 I12 I13<p>
155-
* I21 I22 I23<p>
156-
* I31 I32 I33<p>
159+
* <p>
160+
* For reference, the indeces are as follows:
161+
* <br>I11 I12 I13
162+
* <br>I21 I22 I23
163+
* <br>I31 I32 I33
157164
*
158-
* @param index an array index corresponding with a value inside the matrix
159-
* @return the value at that specific position.
165+
* @param index an array index corresponding with a value inside the matrix
166+
* @return the value at that specific position.
160167
*/
161168
public float get(int index){
162169
return vals[index];
163170
}
164171

165172
/**
166-
* multiplies this matrix by 'b' and returns the result
173+
* multiplies this matrix by 'b' and returns the result.
167174
* See http://en.wikipedia.org/wiki/Matrix_multiplication
175+
*
168176
* @param by The matrix to multiply by
169-
* @return the resulting matrix
177+
* @return the resulting matrix
170178
*/
171179
public Matrix multiply(Matrix by){
172180
Matrix rslt = new Matrix();
@@ -189,7 +197,8 @@ public Matrix multiply(Matrix by){
189197
}
190198

191199
/**
192-
* adds a matrix from this matrix and returns the results
200+
* Adds a matrix from this matrix and returns the results.
201+
*
193202
* @param arg the matrix to subtract from this matrix
194203
* @return a Matrix object
195204
*/
@@ -215,7 +224,8 @@ public Matrix add(Matrix arg){
215224
}
216225

217226
/**
218-
* Subtracts a matrix from this matrix and returns the results
227+
* Subtracts a matrix from this matrix and returns the results.
228+
*
219229
* @param arg the matrix to subtract from this matrix
220230
* @return a Matrix object
221231
*/
@@ -241,6 +251,7 @@ public Matrix subtract(Matrix arg){
241251

242252
/**
243253
* Computes the determinant of the matrix.
254+
*
244255
* @return the determinant of the matrix
245256
*/
246257
public float getDeterminant(){
@@ -257,8 +268,9 @@ public float getDeterminant(){
257268

258269
/**
259270
* Checks equality of matrices.
260-
* @param obj the other Matrix that needs to be compared with this matrix.
261-
* @return true if both matrices are equal
271+
*
272+
* @param obj the other Matrix that needs to be compared with this matrix.
273+
* @return true if both matrices are equal
262274
* @see java.lang.Object#equals(java.lang.Object)
263275
*/
264276
@Override
@@ -271,6 +283,7 @@ public boolean equals(Object obj) {
271283

272284
/**
273285
* Generates a hash code for this object.
286+
*
274287
* @return the hash code of this object
275288
* @see java.lang.Object#hashCode()
276289
*/
@@ -281,6 +294,7 @@ public int hashCode() {
281294

282295
/**
283296
* Generates a String representation of the matrix.
297+
*
284298
* @return the values, delimited with tabs and newlines.
285299
* @see java.lang.Object#toString()
286300
*/

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfEncryption.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,7 @@ public Long getPermissions() {
361361
/**
362362
* Gets encryption algorithm and access permissions.
363363
*
364+
* @return the crypto mode value
364365
* @see EncryptionConstants
365366
*/
366367
public int getCryptoMode() {

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfEncryptor.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,14 +196,18 @@ public static boolean isDegradedPrintingAllowed(int permissions) {
196196

197197
/**
198198
* Gets the content from a recipient.
199+
*
200+
* @param recipientInfo recipient information
201+
* @param certificateKey private certificate key
202+
* @param certificateKeyProvider the name of the certificate key provider
203+
* @return content from a recipient info
204+
* @throws CMSException if the content cannot be recovered.
199205
*/
200206
public static byte[] getContent(RecipientInformation recipientInfo, PrivateKey certificateKey, String certificateKeyProvider) throws CMSException {
201207
Recipient jceKeyTransRecipient = new JceKeyTransEnvelopedRecipient(certificateKey).setProvider(certificateKeyProvider);
202208
return recipientInfo.getContent(jceKeyTransRecipient);
203209
}
204210

205-
206-
207211
/**
208212
* Sets the {@link IMetaInfo} that will be used during {@link PdfDocument} creation.
209213
*

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/draw/DashedLine.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ public DashedLine() {
6363

6464
/**
6565
* Creates an instance of {@link DashedLine} with the specified line width.
66-
* @param lineWidth
66+
*
67+
* @param lineWidth the line width
6768
*/
6869
public DashedLine(float lineWidth) {
6970
this.lineWidth = lineWidth;
@@ -82,7 +83,8 @@ public void draw(PdfCanvas canvas, Rectangle drawArea) {
8283
}
8384

8485
/**
85-
* Gets line width in points
86+
* Gets line width in points.
87+
*
8688
* @return line thickness
8789
*/
8890
@Override
@@ -91,7 +93,8 @@ public float getLineWidth() {
9193
}
9294

9395
/**
94-
* Sets line width in points
96+
* Sets line width in points.
97+
*
9598
* @param lineWidth new line width
9699
*/
97100
@Override

0 commit comments

Comments
 (0)