Skip to content

Commit 0751f3f

Browse files
author
Kate Ivanova
committed
Fix several kernel/pdf/canvas javadoc warnings
DEVSIX-4158
1 parent 390c014 commit 0751f3f

File tree

7 files changed

+19
-18
lines changed

7 files changed

+19
-18
lines changed

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/parser/listener/FilteredEventListener.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public FilteredEventListener() {
7171
* Constructs a {@link FilteredEventListener} instance with one delegate.
7272
* Use {@link #attachEventListener(IEventListener, IEventFilter...)} to add more {@link IEventListener} delegates
7373
* along with their filters.
74-
* @param delegate a delegate that fill be called when all the corresponding filters for an event pass
74+
* @param delegate a delegate that will be called when all the corresponding filters for an event pass
7575
* @param filterSet filters attached to the delegate that will be tested before passing an event on to the delegate
7676
*/
7777
public FilteredEventListener(IEventListener delegate, IEventFilter... filterSet) {
@@ -87,7 +87,8 @@ public FilteredEventListener(IEventListener delegate, IEventFilter... filterSet)
8787
* be parsed just once, so it is better for performance than creating multiple {@link FilteredEventListener}
8888
* instances and parsing the content stream multiple times. This is useful, for instance, when you want
8989
* to extract content from multiple regions of a page.
90-
* @param delegate a delegate that fill be called when all the corresponding filters for an event pass
90+
* @param <T> the type of the delegate
91+
* @param delegate a delegate that will be called when all the corresponding filters for an event pass
9192
* @param filterSet filters attached to the delegate that will be tested before passing an event on to the delegate
9293
* @return delegate that has been passed to the method, used for convenient call chaining
9394
*/

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/wmf/InputMeta.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public InputMeta(InputStream in) {
7171
* Read the next word from the InputStream.
7272
*
7373
* @return the next word or 0 if the end of the stream has been reached
74-
* @throws IOException
74+
* @throws IOException an {@link IOException}
7575
*/
7676
public int readWord() throws IOException {
7777
length += 2;
@@ -85,7 +85,7 @@ public int readWord() throws IOException {
8585
* Read the next short from the InputStream.
8686
*
8787
* @return the next short value
88-
* @throws IOException
88+
* @throws IOException an {@link IOException}
8989
*/
9090
public int readShort() throws IOException{
9191
int k = readWord();
@@ -98,7 +98,7 @@ public int readShort() throws IOException{
9898
* Read the next int from the InputStream.
9999
*
100100
* @return the next int
101-
* @throws IOException
101+
* @throws IOException an {@link IOException}
102102
*/
103103
public int readInt() throws IOException{
104104
length += 4;
@@ -114,7 +114,7 @@ public int readInt() throws IOException{
114114
* Read the next byte from the InputStream.
115115
*
116116
* @return the next byte
117-
* @throws IOException
117+
* @throws IOException an {@link IOException}
118118
*/
119119
public int readByte() throws IOException{
120120
++length;
@@ -125,7 +125,7 @@ public int readByte() throws IOException{
125125
* Skips "len" amount of bytes from the InputStream. If len is &lt; 0, nothing is skipped.
126126
*
127127
* @param len amount of bytes needed to skip
128-
* @throws IOException
128+
* @throws IOException an {@link IOException}
129129
*/
130130
public void skip(int len) throws IOException{
131131
length += len;
@@ -145,7 +145,7 @@ public int getLength() {
145145
* Read the next {@link Color} from the InputStream. This reads 4 bytes.
146146
*
147147
* @return the next Color
148-
* @throws IOException
148+
* @throws IOException an {@link IOException}
149149
*/
150150
public Color readColor() throws IOException{
151151
int red = readByte();

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/wmf/MetaBrush.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public MetaBrush() {
8181
* Initializes this MetaBrush object.
8282
*
8383
* @param in the InputMeta
84-
* @throws IOException
84+
* @throws IOException an {@link IOException}
8585
*/
8686
public void init(InputMeta in) throws IOException {
8787
style = in.readWord();

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/wmf/MetaDo.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ public MetaDo(InputStream in, PdfCanvas cb) {
169169
/**
170170
* Reads and processes all the data of the InputMeta.
171171
*
172-
* @throws IOException
172+
* @throws IOException an {@link IOException}
173173
*/
174174
public void readAll() throws IOException {
175175
if (in.readInt() != 0x9AC6CDD7) {
@@ -611,7 +611,7 @@ public void readAll() throws IOException {
611611
* @param x2 x2-coordinate of the rectangle if clipped or opaque
612612
* @param y2 y1-coordinate of the rectangle if clipped or opaque
613613
* @param text text to output
614-
* @throws IOException
614+
* @throws IOException an {@link IOException}
615615
*/
616616
public void outputText(int x, int y, int flag, int x1, int y1, int x2, int y2, String text) throws IOException {
617617

@@ -739,7 +739,7 @@ static float getArc(float xCenter, float yCenter, float xDot, float yDot) {
739739
*
740740
* @param image the BMP image to be wrapped
741741
* @return the wrapped BMP
742-
* @throws IOException
742+
* @throws IOException an {@link IOException}
743743
*/
744744
public static byte[] wrapBMP(ImageData image) throws IOException {
745745
if (image.getOriginalType() != ImageType.BMP) {
@@ -811,7 +811,7 @@ public static byte[] wrapBMP(ImageData image) throws IOException {
811811
*
812812
* @param os outputstream to write the word to
813813
* @param v value to be written
814-
* @throws IOException
814+
* @throws IOException an {@link IOException}
815815
*/
816816
public static void writeWord(OutputStream os, int v) throws IOException {
817817
os.write(v & 0xff);
@@ -823,7 +823,7 @@ public static void writeWord(OutputStream os, int v) throws IOException {
823823
*
824824
* @param os outputstream to write the dword to
825825
* @param v value to be written
826-
* @throws IOException
826+
* @throws IOException an {@link IOException}
827827
*/
828828
public static void writeDWord(OutputStream os, int v) throws IOException {
829829
writeWord(os, v & 0xffff);

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/wmf/MetaFont.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ public MetaFont() {
106106
* Initializes the MetaFont instance.
107107
*
108108
* @param in InputMeta containing the WMF data
109-
* @throws IOException
109+
* @throws IOException an {@link IOException}
110110
*/
111111
public void init(InputMeta in) throws IOException {
112112
height = Math.abs(in.readShort());
@@ -141,7 +141,7 @@ public void init(InputMeta in) throws IOException {
141141
* Returns the Font.
142142
*
143143
* @return the font
144-
* @throws IOException
144+
* @throws IOException an {@link IOException}
145145
*/
146146
public FontProgram getFont() throws IOException {
147147
if (font != null)

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/wmf/MetaPen.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public MetaPen() {
7676
* Initializes a MetaPen object.
7777
*
7878
* @param in the InputMeta object that holds the inputstream of the WMF image
79-
* @throws IOException
79+
* @throws IOException an {@link IOException}
8080
*/
8181
public void init(InputMeta in) throws IOException {
8282
style = in.readWord();

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/wmf/WmfImageData.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public class WmfImageData extends ImageData {
6565
* Creates a WmfImage from a file.
6666
*
6767
* @param fileName pah to the file
68-
* @throws MalformedURLException
68+
* @throws MalformedURLException a {@link MalformedURLException}
6969
*/
7070
public WmfImageData(String fileName) throws MalformedURLException {
7171
this(UrlUtil.toURL(fileName));

0 commit comments

Comments
 (0)