Skip to content

Commit 652f500

Browse files
Kate IvanovaiText-CI
authored andcommitted
Improve Javadocs of io and styled-xml-parser
Implemented during the third technical debt session DEVSIX-3096
1 parent 1d22783 commit 652f500

File tree

5 files changed

+19
-6
lines changed

5 files changed

+19
-6
lines changed

io/src/main/java/com/itextpdf/io/codec/TIFFField.java

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,33 +125,46 @@ public class TIFFField implements Comparable<TIFFField>, Serializable {
125125
* unsigned data type, long is used. The mapping between types is
126126
* as follows:
127127
*
128-
* <table border=1 summary="TIFFField data">
128+
* <table border="1" summary="TIFFField data">
129129
* <tr>
130130
* <th> TIFF type </th> <th> Java type </th>
131+
* </tr>
131132
* <tr>
132133
* <td><tt>TIFF_BYTE</tt></td> <td><tt>byte</tt></td>
134+
* </tr>
133135
* <tr>
134136
* <td><tt>TIFF_ASCII</tt></td> <td><tt>String</tt></td>
137+
* </tr>
135138
* <tr>
136139
* <td><tt>TIFF_SHORT</tt></td> <td><tt>char</tt></td>
140+
* </tr>
137141
* <tr>
138142
* <td><tt>TIFF_LONG</tt></td> <td><tt>long</tt></td>
143+
* </tr>
139144
* <tr>
140145
* <td><tt>TIFF_RATIONAL</tt></td> <td><tt>long[2]</tt></td>
146+
* </tr>
141147
* <tr>
142148
* <td><tt>TIFF_SBYTE</tt></td> <td><tt>byte</tt></td>
149+
* </tr>
143150
* <tr>
144151
* <td><tt>TIFF_UNDEFINED</tt></td> <td><tt>byte</tt></td>
152+
* </tr>
145153
* <tr>
146154
* <td><tt>TIFF_SSHORT</tt></td> <td><tt>short</tt></td>
155+
* </tr>
147156
* <tr>
148157
* <td><tt>TIFF_SLONG</tt></td> <td><tt>int</tt></td>
158+
* </tr>
149159
* <tr>
150160
* <td><tt>TIFF_SRATIONAL</tt></td> <td><tt>int[2]</tt></td>
161+
* </tr>
151162
* <tr>
152163
* <td><tt>TIFF_FLOAT</tt></td> <td><tt>float</tt></td>
164+
* </tr>
153165
* <tr>
154166
* <td><tt>TIFF_DOUBLE</tt></td> <td><tt>double</tt></td>
167+
* </tr>
155168
* </table>
156169
*
157170
* @param tag The tag

io/src/main/java/com/itextpdf/io/font/FontRegisterProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ int registerFontDirectory(String dir) {
319319
* Register all the fonts in a directory and possibly its subdirectories.
320320
*
321321
* @param dir the directory
322-
* @param scanSubdirectories recursively scan subdirectories if <code>true</true>
322+
* @param scanSubdirectories recursively scan subdirectories if <code>true</code>
323323
* @return the number of fonts registered
324324
*/
325325
int registerFontDirectory(String dir, boolean scanSubdirectories) {

io/src/main/java/com/itextpdf/io/image/JpegImageHelper.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ private static int getShort(InputStream jpegStream) throws java.io.IOException {
389389
* Returns a type of marker.
390390
*
391391
* @param marker an int
392-
* @return a type: <VAR>VALID_MARKER</CODE>, <VAR>UNSUPPORTED_MARKER</VAR> or <VAR>NOPARAM_MARKER</VAR>
392+
* @return a type: <VAR>VALID_MARKER</VAR>, <VAR>UNSUPPORTED_MARKER</VAR> or <VAR>NOPARAM_MARKER</VAR>
393393
*/
394394
private static int marker(int marker) {
395395
for (int i = 0; i < VALID_MARKERS.length; i++) {

styled-xml-parser/src/main/java/com/itextpdf/styledxmlparser/jsoup/select/Selector.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,13 @@ This file is part of the iText (R) project.
7878
* <tr><td><code>[attr*=valContaining]</code></td><td>elements with an attribute named "attr", and value containing "valContaining"</td><td><code>a[href*=/search/]</code></td></tr>
7979
* <tr><td><code>[attr~=<em>regex</em>]</code></td><td>elements with an attribute named "attr", and value matching the regular expression</td><td><code>img[src~=(?i)\\.(png|jpe?g)]</code></td></tr>
8080
* <tr><td></td><td>The above may be combined in any order</td><td><code>div.header[title]</code></td></tr>
81-
* <tr><td><td colspan="3"><h3>Combinators</h3></td></tr>
81+
* <tr><td colspan="3"><h3>Combinators</h3></td></tr>
8282
* <tr><td><code>E F</code></td><td>an F element descended from an E element</td><td><code>div a</code>, <code>.logo h1</code></td></tr>
8383
* <tr><td><code>E {@literal >} F</code></td><td>an F direct child of E</td><td><code>ol {@literal >} li</code></td></tr>
8484
* <tr><td><code>E + F</code></td><td>an F element immediately preceded by sibling E</td><td><code>li + li</code>, <code>div.head + div</code></td></tr>
8585
* <tr><td><code>E ~ F</code></td><td>an F element preceded by sibling E</td><td><code>h1 ~ p</code></td></tr>
8686
* <tr><td><code>E, F, G</code></td><td>all matching elements E, F, or G</td><td><code>a[href], div, h3</code></td></tr>
87-
* <tr><td><td colspan="3"><h3>Pseudo selectors</h3></td></tr>
87+
* <tr><td colspan="3"><h3>Pseudo selectors</h3></td></tr>
8888
* <tr><td><code>:lt(<em>n</em>)</code></td><td>elements whose sibling index is less than <em>n</em></td><td><code>td:lt(3)</code> finds the first 3 cells of each row</td></tr>
8989
* <tr><td><code>:gt(<em>n</em>)</code></td><td>elements whose sibling index is greater than <em>n</em></td><td><code>td:gt(1)</code> finds cells after skipping the first two</td></tr>
9090
* <tr><td><code>:eq(<em>n</em>)</code></td><td>elements whose sibling index is equal to <em>n</em></td><td><code>td:eq(0)</code> finds the first cell of each row</td></tr>

styled-xml-parser/src/main/java/com/itextpdf/styledxmlparser/resolver/resource/ResourceResolver.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ protected PdfXObject createImageByUrl(URL url) throws Exception {
316316
}
317317

318318
/**
319-
* Checks if source is under data URI scheme. (eg data:[<media type>][;base64],<data>)
319+
* Checks if source is under data URI scheme. (eg data:[&lt;media type&gt;][;base64],&lt;data&gt;)
320320
*
321321
* @param src String to test
322322
* @return

0 commit comments

Comments
 (0)