Skip to content
This repository was archived by the owner on Sep 4, 2025. It is now read-only.

Commit 17bd0f2

Browse files
zhuangjiajuzhuangjiaju
authored
Merge pull request #2928 from alibaba/bugfix
修改javadoc报错
2 parents 52195c9 + eadebfe commit 17bd0f2

File tree

4 files changed

+46
-97
lines changed

4 files changed

+46
-97
lines changed

‎easyexcel-core/src/main/java/com/alibaba/excel/EasyExcelFactory.java‎

Lines changed: 36 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,10 @@
1414
/**
1515
* Reader and writer factory class
1616
*
17-
* <h1>Quick start</h1>
18-
* <h2>Read</h2>
19-
* <h3>Sample1</h3>
20-
*
21-
* <h3>Sample2</h3>
22-
*
23-
* <h2>Write</h2>
24-
*
25-
* <h3>Sample1</h3>
26-
*
27-
* <h3>Sample2</h3>
28-
*
29-
*
30-
*
3117
* @author jipengfei
3218
*/
3319
public class EasyExcelFactory {
3420

35-
3621
/**
3722
* Build excel the write
3823
*
@@ -45,8 +30,7 @@ public static ExcelWriterBuilder write() {
4530
/**
4631
* Build excel the write
4732
*
48-
* @param file
49-
* File to write
33+
* @param file File to write
5034
* @return Excel writer builder
5135
*/
5236
public static ExcelWriterBuilder write(File file) {
@@ -56,10 +40,8 @@ public static ExcelWriterBuilder write(File file) {
5640
/**
5741
* Build excel the write
5842
*
59-
* @param file
60-
* File to write
61-
* @param head
62-
* Annotate the class for configuration information
43+
* @param file File to write
44+
* @param head Annotate the class for configuration information
6345
* @return Excel writer builder
6446
*/
6547
public static ExcelWriterBuilder write(File file, Class head) {
@@ -74,8 +56,7 @@ public static ExcelWriterBuilder write(File file, Class head) {
7456
/**
7557
* Build excel the write
7658
*
77-
* @param pathName
78-
* File path to write
59+
* @param pathName File path to write
7960
* @return Excel writer builder
8061
*/
8162
public static ExcelWriterBuilder write(String pathName) {
@@ -85,10 +66,8 @@ public static ExcelWriterBuilder write(String pathName) {
8566
/**
8667
* Build excel the write
8768
*
88-
* @param pathName
89-
* File path to write
90-
* @param head
91-
* Annotate the class for configuration information
69+
* @param pathName File path to write
70+
* @param head Annotate the class for configuration information
9271
* @return Excel writer builder
9372
*/
9473
public static ExcelWriterBuilder write(String pathName, Class head) {
@@ -103,8 +82,7 @@ public static ExcelWriterBuilder write(String pathName, Class head) {
10382
/**
10483
* Build excel the write
10584
*
106-
* @param outputStream
107-
* Output stream to write
85+
* @param outputStream Output stream to write
10886
* @return Excel writer builder
10987
*/
11088
public static ExcelWriterBuilder write(OutputStream outputStream) {
@@ -114,10 +92,8 @@ public static ExcelWriterBuilder write(OutputStream outputStream) {
11492
/**
11593
* Build excel the write
11694
*
117-
* @param outputStream
118-
* Output stream to write
119-
* @param head
120-
* Annotate the class for configuration information.
95+
* @param outputStream Output stream to write
96+
* @param head Annotate the class for configuration information.
12197
* @return Excel writer builder
12298
*/
12399
public static ExcelWriterBuilder write(OutputStream outputStream, Class head) {
@@ -141,8 +117,7 @@ public static ExcelWriterSheetBuilder writerSheet() {
141117
/**
142118
* Build excel the <code>writerSheet</code>
143119
*
144-
* @param sheetNo
145-
* Index of sheet,0 base.
120+
* @param sheetNo Index of sheet,0 base.
146121
* @return Excel sheet writer builder.
147122
*/
148123
public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo) {
@@ -152,8 +127,7 @@ public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo) {
152127
/**
153128
* Build excel the 'writerSheet'
154129
*
155-
* @param sheetName
156-
* The name of sheet.
130+
* @param sheetName The name of sheet.
157131
* @return Excel sheet writer builder.
158132
*/
159133
public static ExcelWriterSheetBuilder writerSheet(String sheetName) {
@@ -163,10 +137,8 @@ public static ExcelWriterSheetBuilder writerSheet(String sheetName) {
163137
/**
164138
* Build excel the 'writerSheet'
165139
*
166-
* @param sheetNo
167-
* Index of sheet,0 base.
168-
* @param sheetName
169-
* The name of sheet.
140+
* @param sheetNo Index of sheet,0 base.
141+
* @param sheetName The name of sheet.
170142
* @return Excel sheet writer builder.
171143
*/
172144
public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo, String sheetName) {
@@ -192,8 +164,7 @@ public static ExcelWriterTableBuilder writerTable() {
192164
/**
193165
* Build excel the 'writerTable'
194166
*
195-
* @param tableNo
196-
* Index of table,0 base.
167+
* @param tableNo Index of table,0 base.
197168
* @return Excel table writer builder.
198169
*/
199170
public static ExcelWriterTableBuilder writerTable(Integer tableNo) {
@@ -216,8 +187,7 @@ public static ExcelReaderBuilder read() {
216187
/**
217188
* Build excel the read
218189
*
219-
* @param file
220-
* File to read.
190+
* @param file File to read.
221191
* @return Excel reader builder.
222192
*/
223193
public static ExcelReaderBuilder read(File file) {
@@ -227,10 +197,8 @@ public static ExcelReaderBuilder read(File file) {
227197
/**
228198
* Build excel the read
229199
*
230-
* @param file
231-
* File to read.
232-
* @param readListener
233-
* Read listener.
200+
* @param file File to read.
201+
* @param readListener Read listener.
234202
* @return Excel reader builder.
235203
*/
236204
public static ExcelReaderBuilder read(File file, ReadListener readListener) {
@@ -240,12 +208,9 @@ public static ExcelReaderBuilder read(File file, ReadListener readListener) {
240208
/**
241209
* Build excel the read
242210
*
243-
* @param file
244-
* File to read.
245-
* @param head
246-
* Annotate the class for configuration information.
247-
* @param readListener
248-
* Read listener.
211+
* @param file File to read.
212+
* @param head Annotate the class for configuration information.
213+
* @param readListener Read listener.
249214
* @return Excel reader builder.
250215
*/
251216
public static ExcelReaderBuilder read(File file, Class head, ReadListener readListener) {
@@ -263,8 +228,7 @@ public static ExcelReaderBuilder read(File file, Class head, ReadListener readLi
263228
/**
264229
* Build excel the read
265230
*
266-
* @param pathName
267-
* File path to read.
231+
* @param pathName File path to read.
268232
* @return Excel reader builder.
269233
*/
270234
public static ExcelReaderBuilder read(String pathName) {
@@ -274,10 +238,8 @@ public static ExcelReaderBuilder read(String pathName) {
274238
/**
275239
* Build excel the read
276240
*
277-
* @param pathName
278-
* File path to read.
279-
* @param readListener
280-
* Read listener.
241+
* @param pathName File path to read.
242+
* @param readListener Read listener.
281243
* @return Excel reader builder.
282244
*/
283245
public static ExcelReaderBuilder read(String pathName, ReadListener readListener) {
@@ -287,12 +249,9 @@ public static ExcelReaderBuilder read(String pathName, ReadListener readListener
287249
/**
288250
* Build excel the read
289251
*
290-
* @param pathName
291-
* File path to read.
292-
* @param head
293-
* Annotate the class for configuration information.
294-
* @param readListener
295-
* Read listener.
252+
* @param pathName File path to read.
253+
* @param head Annotate the class for configuration information.
254+
* @param readListener Read listener.
296255
* @return Excel reader builder.
297256
*/
298257
public static ExcelReaderBuilder read(String pathName, Class head, ReadListener readListener) {
@@ -310,8 +269,7 @@ public static ExcelReaderBuilder read(String pathName, Class head, ReadListener
310269
/**
311270
* Build excel the read
312271
*
313-
* @param inputStream
314-
* Input stream to read.
272+
* @param inputStream Input stream to read.
315273
* @return Excel reader builder.
316274
*/
317275
public static ExcelReaderBuilder read(InputStream inputStream) {
@@ -321,10 +279,8 @@ public static ExcelReaderBuilder read(InputStream inputStream) {
321279
/**
322280
* Build excel the read
323281
*
324-
* @param inputStream
325-
* Input stream to read.
326-
* @param readListener
327-
* Read listener.
282+
* @param inputStream Input stream to read.
283+
* @param readListener Read listener.
328284
* @return Excel reader builder.
329285
*/
330286
public static ExcelReaderBuilder read(InputStream inputStream, ReadListener readListener) {
@@ -334,12 +290,9 @@ public static ExcelReaderBuilder read(InputStream inputStream, ReadListener read
334290
/**
335291
* Build excel the read
336292
*
337-
* @param inputStream
338-
* Input stream to read.
339-
* @param head
340-
* Annotate the class for configuration information.
341-
* @param readListener
342-
* Read listener.
293+
* @param inputStream Input stream to read.
294+
* @param head Annotate the class for configuration information.
295+
* @param readListener Read listener.
343296
* @return Excel reader builder.
344297
*/
345298
public static ExcelReaderBuilder read(InputStream inputStream, Class head, ReadListener readListener) {
@@ -366,8 +319,7 @@ public static ExcelReaderSheetBuilder readSheet() {
366319
/**
367320
* Build excel the 'readSheet'
368321
*
369-
* @param sheetNo
370-
* Index of sheet,0 base.
322+
* @param sheetNo Index of sheet,0 base.
371323
* @return Excel sheet reader builder.
372324
*/
373325
public static ExcelReaderSheetBuilder readSheet(Integer sheetNo) {
@@ -377,8 +329,7 @@ public static ExcelReaderSheetBuilder readSheet(Integer sheetNo) {
377329
/**
378330
* Build excel the 'readSheet'
379331
*
380-
* @param sheetName
381-
* The name of sheet.
332+
* @param sheetName The name of sheet.
382333
* @return Excel sheet reader builder.
383334
*/
384335
public static ExcelReaderSheetBuilder readSheet(String sheetName) {
@@ -388,10 +339,8 @@ public static ExcelReaderSheetBuilder readSheet(String sheetName) {
388339
/**
389340
* Build excel the 'readSheet'
390341
*
391-
* @param sheetNo
392-
* Index of sheet,0 base.
393-
* @param sheetName
394-
* The name of sheet.
342+
* @param sheetNo Index of sheet,0 base.
343+
* @param sheetName The name of sheet.
395344
* @return Excel sheet reader builder.
396345
*/
397346
public static ExcelReaderSheetBuilder readSheet(Integer sheetNo, String sheetName) {

‎easyexcel-core/src/main/java/com/alibaba/excel/enums/ReadDefaultReturnEnum.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ public enum ReadDefaultReturnEnum {
2323
* Returns the actual type.
2424
* Will be automatically selected according to the cell contents what return type, will return the following class:
2525
* <ol>
26-
* <li>{@link BigDecimal}<li/>
27-
* <li>{@link Boolean}<li/>
28-
* <li>{@link String}<li/>
29-
* <li>{@link LocalDateTime}<li/>
30-
* <ol/>
26+
* <li>{@link BigDecimal}</li>
27+
* <li>{@link Boolean}</li>
28+
* <li>{@link String}</li>
29+
* <li>{@link LocalDateTime}</li>
30+
* </ol>
3131
*/
3232
ACTUAL_DATA,
3333

‎easyexcel-core/src/main/java/com/alibaba/excel/metadata/data/ReadCellData.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public class ReadCellData<T> extends CellData<T> {
4040
* for example, originalNumberValue = `44729.99998836806` ,time is:`2022-06-17 23:59:58.995`,
4141
* But in excel is displayed:` 2022-06-17 23:59:59`, dateValue = `2022-06-17 23:59:59`
4242
* </li>
43-
* <ol/>
43+
* </ol>
4444
* {@link CellDataTypeEnum#NUMBER} {@link CellDataTypeEnum#DATE}
4545
*/
4646
private BigDecimal originalNumberValue;

‎easyexcel-core/src/main/java/com/alibaba/excel/write/metadata/RowData.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ public interface RowData {
1818

1919
/**
2020
* Returns the number of elements in this collection. If this collection
21-
* contains more than <tt>Integer.MAX_VALUE</tt> elements, returns
22-
* <tt>Integer.MAX_VALUE</tt>.
21+
* contains more than <code>Integer.MAX_VALUE</code> elements, returns
22+
* <code>Integer.MAX_VALUE</code>.
2323
*
2424
* @return the number of elements in this collection
2525
*/
2626
int size();
2727

2828
/**
29-
* Returns <tt>true</tt> if this collection contains no elements.
29+
* Returns <code>true</code> if this collection contains no elements.
3030
*
31-
* @return <tt>true</tt> if this collection contains no elements
31+
* @return <code>true</code> if this collection contains no elements
3232
*/
3333
boolean isEmpty();
3434

0 commit comments

Comments
 (0)