Skip to content

Commit 233b5b2

Browse files
committed
Javadoc
Add an empty line before a Javadoc comment
1 parent f0c33e8 commit 233b5b2

33 files changed

+185
-1
lines changed

src/main/java/org/apache/commons/imaging/ImageFormats.java

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,48 +25,70 @@ public enum ImageFormats implements ImageFormat {
2525

2626
/** Unknown image format. */
2727
UNKNOWN("bin"),
28+
2829
/** BMP (Windows Bitmap) image format. */
2930
BMP("bmp", "dib"),
31+
3032
/** DCX (ZSoft Multi-page Paintbrush) image format. */
3133
DCX("dcx"),
34+
3235
/** GIF (Graphics Interchange Format) image format. */
3336
GIF("gif"),
37+
3438
/** ICNS (Apple Icon Image) format. */
3539
ICNS("icns"),
40+
3641
/** ICO (Windows Icon) image format. */
3742
ICO("ico"),
43+
3844
/** JBIG2 image format. */
3945
JBIG2("jbig2"),
46+
4047
/** JPEG (Joint Photographic Experts Group) image format. */
4148
JPEG("jpg", "jpeg"),
49+
4250
/** PAM (Portable Arbitrary Map) image format. */
4351
PAM("pam"),
52+
4453
/** PSD (Adobe Photoshop Document) image format. */
4554
PSD("psd"),
55+
4656
/** PBM (Portable Bitmap) image format. */
4757
PBM("pbm"),
58+
4859
/** PGM (Portable Graymap) image format. */
4960
PGM("pgm"),
61+
5062
/** PNM (Portable Any Map) image format. */
5163
PNM("pnm"),
64+
5265
/** PPM (Portable Pixmap) image format. */
5366
PPM("ppm"),
67+
5468
/** PCX (PC Paintbrush) image format. */
5569
PCX("pcx", "pcc"),
70+
5671
/** PNG (Portable Network Graphics) image format. */
5772
PNG("png"),
73+
5874
/** RGBE (Radiance HDR) image format. */
5975
RGBE("hdr", "pic"),
76+
6077
/** TGA (Truevision TGA/TARGA) image format. */
6178
TGA("tga"),
79+
6280
/** TIFF (Tagged Image File Format). */
6381
TIFF("tif", "tiff"),
82+
6483
/** WBMP (Wireless Bitmap) image format. */
6584
WBMP("wbmp"),
85+
6686
/** WebP image format. */
6787
WEBP("webp"),
88+
6889
/** XBM (X11 Bitmap) image format. */
6990
XBM("xbm"),
91+
7092
/** XPM (X11 Pixmap) image format. */
7193
XPM("xpm");
7294

src/main/java/org/apache/commons/imaging/ImageInfo.java

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,31 @@ public class ImageInfo {
3030

3131
/** Color type enumeration for images. */
3232
public enum ColorType {
33+
3334
/** Black and white images. */
3435
BW("Black and White"),
36+
3537
/** Grayscale images. */
3638
GRAYSCALE("Grayscale"),
39+
3740
/** RGB color images. */
3841
RGB("RGB"),
42+
3943
/** CMYK color images. */
4044
CMYK("CMYK"),
45+
4146
/** YCbCr color images. */
4247
YCbCr("YCbCr"),
48+
4349
/** YCCK color images. */
4450
YCCK("YCCK"),
51+
4552
/** YCC color images. */
4653
YCC("YCC"),
54+
4755
/** Other color type. */
4856
OTHER("Other"),
57+
4958
/** Unknown color type. */
5059
UNKNOWN("Unknown");
5160

@@ -63,32 +72,46 @@ public String toString() {
6372

6473
/** Compression algorithm enumeration for images. */
6574
public enum CompressionAlgorithm {
75+
6676
/** Unknown compression. */
6777
UNKNOWN("Unknown"),
78+
6879
/** No compression. */
6980
NONE("None"),
81+
7082
/** LZW compression. */
7183
LZW("LZW"),
84+
7285
/** PackBits compression. */
7386
PACKBITS("PackBits"),
87+
7488
/** JPEG compression (TIFF obsolete). */
7589
JPEG_TIFF_OBSOLETE("JPEG Obsolete (TIFF only)"),
90+
7691
/** JPEG compression. */
7792
JPEG("JPEG"),
93+
7894
/** RLE: Run-Length Encoding. */
7995
RLE("RLE: Run-Length Encoding"),
96+
8097
/** Adaptive RLE compression. */
8198
ADAPTIVE_RLE("Adaptive RLE"),
99+
82100
/** Photoshop compression. */
83101
PSD("Photoshop"),
102+
84103
/** PNG Filter compression. */
85104
PNG_FILTER("PNG Filter"),
105+
86106
/** CCITT Group 3 1-Dimensional Modified Huffman run-length encoding. */
87107
CCITT_GROUP_3("CCITT Group 3 1-Dimensional Modified Huffman run-length encoding."),
108+
88109
/** CCITT Group 4 compression. */
89110
CCITT_GROUP_4("CCITT Group 4"),
111+
90112
/** CCITT 1D compression. */
91113
CCITT_1D("CCITT 1D"),
114+
92115
/** DEFLATE (ZIP) compression. */
93116
DEFLATE("DEFLATE (ZIP)");
94117

src/main/java/org/apache/commons/imaging/common/BasicCParser.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
* FIXME replace this by a parser generated via ANTLR (if we really need it?!)
3333
*/
3434
public class BasicCParser {
35+
3536
/**
3637
* Parses the hexadecimal-base escape-sequence found at index {@code i} of {@code string}.
3738
*

src/main/java/org/apache/commons/imaging/common/ImageMetadata.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
* Image metadata.
2323
*/
2424
public interface ImageMetadata {
25+
2526
/**
2627
* Represents a single metadata item.
2728
*/

src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcRecord.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@
2222
* Represents an IPTC record, a single key-value pair of Photoshop IPTC data.
2323
*/
2424
public class IptcRecord {
25+
2526
/** Comparator for sorting IPTC records by type. */
2627
public static final Comparator<IptcRecord> COMPARATOR = Comparator.comparingInt(e -> e.iptcType.getType());
28+
2729
/** The IPTC type. */
2830
public final IptcType iptcType;
2931
private final String value;

src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcType.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
* IPTC metadata types.
2121
*/
2222
public interface IptcType {
23+
2324
/**
2425
* Gets the name of this IPTC type.
2526
*

src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcTypes.java

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,118 +20,175 @@
2020
* Enumeration of IPTC (International Press Telecommunications Council) metadata record types.
2121
*/
2222
public enum IptcTypes implements IptcType {
23+
2324
/** Record version type. */
2425
RECORD_VERSION(0, "Record Version"),
26+
2527
/** Object type reference type. */
2628
OBJECT_TYPE_REFERENCE(3, "Object Type Reference"),
29+
2730
/** Object attribute reference type. */
2831
OBJECT_ATTRIBUTE_REFERENCE(4, "Object Attribute Reference"),
32+
2933
/** Object name type. */
3034
OBJECT_NAME(5, "Object Name"),
35+
3136
/** Edit status type. */
3237
EDIT_STATUS(7, "Edit Status"),
38+
3339
/** Editorial update type. */
3440
EDITORIAL_UPDATE(8, "Editorial Update"),
41+
3542
/** Urgency type. */
3643
URGENCY(10, "Urgency"),
44+
3745
/** Subject reference type. */
3846
SUBJECT_REFERENCE(12, "Subject Reference"),
47+
3948
/** Category type. */
4049
CATEGORY(15, "Category"),
50+
4151
/** Supplemental category type. */
4252
SUPPLEMENTAL_CATEGORY(20, "Supplemental Category"),
53+
4354
/** Fixture identifier type. */
4455
FIXTURE_IDENTIFIER(22, "Fixture Identifier"),
56+
4557
/** Keywords type. */
4658
KEYWORDS(25, "Keywords"),
59+
4760
/** Content location code type. */
4861
CONTENT_LOCATION_CODE(26, "Content Location Code"),
62+
4963
/** Content location name type. */
5064
CONTENT_LOCATION_NAME(27, "Content Location Name"),
65+
5166
/** Release date type. */
5267
RELEASE_DATE(30, "Release Date"),
68+
5369
/** Release time type. */
5470
RELEASE_TIME(35, "Release Time"),
71+
5572
/** Expiration date type. */
5673
EXPIRATION_DATE(37, "Expiration Date"),
74+
5775
/** Expiration time type. */
5876
EXPIRATION_TIME(38, "Expiration Time"),
77+
5978
/** Special instructions type. */
6079
SPECIAL_INSTRUCTIONS(40, "Special Instructions"),
80+
6181
/** Action advised type. */
6282
ACTION_ADVISED(42, "Action Advised"),
83+
6384
/** Reference service type. */
6485
REFERENCE_SERVICE(45, "Reference Service"),
86+
6587
/** Reference date type. */
6688
REFERENCE_DATE(47, "Reference Date"),
89+
6790
/** Reference number type. */
6891
REFERENCE_NUMBER(50, "Reference Number"),
92+
6993
/** Date created type. */
7094
DATE_CREATED(55, "Date Created"),
95+
7196
/** Time created type. */
7297
TIME_CREATED(60, "Time Created"),
98+
7399
/** Digital creation date type. */
74100
DIGITAL_CREATION_DATE(62, "Digital Creation Date"),
101+
75102
/** Digital creation time type. */
76103
DIGITAL_CREATION_TIME(63, "Digital Creation Time"),
104+
77105
/** Originating program type. */
78106
ORIGINATING_PROGRAM(65, "Originating Program"),
107+
79108
/** Program version type. */
80109
PROGRAM_VERSION(70, "Program Version"),
110+
81111
/** Object cycle type. */
82112
OBJECT_CYCLE(75, "Object Cycle"),
113+
83114
/** By-line type. */
84115
BYLINE(80, "By-line"),
116+
85117
/** By-line title type. */
86118
BYLINE_TITLE(85, "By-line Title"),
119+
87120
/** City type. */
88121
CITY(90, "City"),
122+
89123
/** Sublocation type. */
90124
SUBLOCATION(92, "Sublocation"),
125+
91126
/** Province/State type. */
92127
PROVINCE_STATE(95, "Province/State"),
128+
93129
/** Country/Primary location code type. */
94130
COUNTRY_PRIMARY_LOCATION_CODE(100, "Country/Primary Location Code"),
131+
95132
/** Country/Primary location name type. */
96133
COUNTRY_PRIMARY_LOCATION_NAME(101, "Country/Primary Location Name"),
134+
97135
/** Original transmission reference type. */
98136
ORIGINAL_TRANSMISSION_REFERENCE(103, "Original Transmission, Reference"),
137+
99138
/** Headline type. */
100139
HEADLINE(105, "Headline"),
140+
101141
/** Credit type. */
102142
CREDIT(110, "Credit"),
143+
103144
/** Source type. */
104145
SOURCE(115, "Source"),
146+
105147
/** Copyright notice type. */
106148
COPYRIGHT_NOTICE(116, "Copyright Notice"),
149+
107150
/** Contact type. */
108151
CONTACT(118, "Contact"),
152+
109153
/** Caption/Abstract type. */
110154
CAPTION_ABSTRACT(120, "Caption/Abstract"),
155+
111156
/** Writer/Editor type. */
112157
WRITER_EDITOR(122, "Writer/Editor"),
158+
113159
/** Rasterized caption type. */
114160
RASTERIZED_CAPTION(125, "Rasterized Caption"),
161+
115162
/** Image type. */
116163
IMAGE_TYPE(130, "ImageType"),
164+
117165
/** Image orientation type. */
118166
IMAGE_ORIENTATION(131, "Image Orientation"),
167+
119168
/** Language identifier type. */
120169
LANGUAGE_IDENTIFIER(135, "Language Identifier"),
170+
121171
/** Audio type. */
122172
AUDIO_TYPE(150, "Audio Type"),
173+
123174
/** Audio sampling rate type. */
124175
AUDIO_SAMPLING_RATE(151, "Audio Sampling Rate"),
176+
125177
/** Audio sampling resolution type. */
126178
AUDIO_SAMPLING_RESOLUTION(152, "Audio Sampling Resolution"),
179+
127180
/** Audio duration type. */
128181
AUDIO_DURATION(153, "Audio Duration"),
182+
129183
/** Audio outcue type. */
130184
AUDIO_OUTCUE(154, "Audio Outcue"),
185+
131186
/** Object data preview file format type. */
132187
OBJECT_DATA_PREVIEW_FILE_FORMAT(200, "Object Data Preview, File Format"),
188+
133189
/** Object data preview file format version type. */
134190
OBJECT_DATA_PREVIEW_FILE_FORMAT_VERSION(201, "Object Data Preview, File Format Version"),
191+
135192
/** Object data preview data type. */
136193
OBJECT_DATA_PREVIEW_DATA(202, "Object Data Preview Data");
137194

src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DqtSegment.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ public final class DqtSegment extends AbstractSegment {
3535
* A quantization table for JPEG compression.
3636
*/
3737
public static class QuantizationTable {
38+
3839
/** The precision of the quantization table (0=8-bit, 1=16-bit). */
3940
public final int precision;
4041

0 commit comments

Comments
 (0)