Skip to content

Commit 4a0bf37

Browse files
committed
Javadoc: Use the active voice.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1739189 13f79535-47bb-0310-9956-ffa450edef68
1 parent 3137377 commit 4a0bf37

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

src/main/java/org/apache/commons/io/output/XmlStreamWriter.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public class XmlStreamWriter extends Writer {
5151
private String encoding;
5252

5353
/**
54-
* Construct a new XML stream writer for the specified output stream
54+
* Constructs a new XML stream writer for the specified output stream
5555
* with a default encoding of UTF-8.
5656
*
5757
* @param out The output stream
@@ -61,7 +61,7 @@ public XmlStreamWriter(final OutputStream out) {
6161
}
6262

6363
/**
64-
* Construct a new XML stream writer for the specified output stream
64+
* Constructs a new XML stream writer for the specified output stream
6565
* with the specified default encoding.
6666
*
6767
* @param out The output stream
@@ -73,7 +73,7 @@ public XmlStreamWriter(final OutputStream out, final String defaultEncoding) {
7373
}
7474

7575
/**
76-
* Construct a new XML stream writer for the specified file
76+
* Constructs a new XML stream writer for the specified file
7777
* with a default encoding of UTF-8.
7878
*
7979
* @param file The file to write to
@@ -85,7 +85,7 @@ public XmlStreamWriter(final File file) throws FileNotFoundException {
8585
}
8686

8787
/**
88-
* Construct a new XML stream writer for the specified file
88+
* Constructs a new XML stream writer for the specified file
8989
* with the specified default encoding.
9090
*
9191
* @param file The file to write to
@@ -98,7 +98,7 @@ public XmlStreamWriter(final File file, final String defaultEncoding) throws Fil
9898
}
9999

100100
/**
101-
* Return the detected encoding.
101+
* Returns the detected encoding.
102102
*
103103
* @return the detected encoding
104104
*/
@@ -107,7 +107,7 @@ public String getEncoding() {
107107
}
108108

109109
/**
110-
* Return the default encoding.
110+
* Returns the default encoding.
111111
*
112112
* @return the default encoding
113113
*/
@@ -116,7 +116,7 @@ public String getDefaultEncoding() {
116116
}
117117

118118
/**
119-
* Close the underlying writer.
119+
* Closes the underlying writer.
120120
*
121121
* @throws IOException if an error occurs closing the underlying writer
122122
*/
@@ -131,7 +131,7 @@ public void close() throws IOException {
131131
}
132132

133133
/**
134-
* Flush the underlying writer.
134+
* Flushes the underlying writer.
135135
*
136136
* @throws IOException if an error occurs flushing the underlying writer
137137
*/
@@ -143,7 +143,7 @@ public void flush() throws IOException {
143143
}
144144

145145
/**
146-
* Detect the encoding.
146+
* Detects the encoding.
147147
*
148148
* @param cbuf the buffer to write the characters from
149149
* @param off The start offset
@@ -200,7 +200,7 @@ private void detectEncoding(final char[] cbuf, final int off, final int len)
200200
}
201201

202202
/**
203-
* Write the characters to the underlying writer, detecing encoding.
203+
* Writes the characters to the underlying writer, detecing encoding.
204204
*
205205
* @param cbuf the buffer to write the characters from
206206
* @param off The start offset

0 commit comments

Comments
 (0)