This is an automated email from the ASF dual-hosted git repository.
delei pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fesod.git
The following commit(s) were added to refs/heads/main by this push:
new 55911dc9 docs: improve Javadoc (#735)
55911dc9 is described below
commit 55911dc93813781229a2812bbfdee9f29567fc56
Author: Tran Ngoc Nhan <[email protected]>
AuthorDate: Sun Dec 14 22:17:44 2025 +0700
docs: improve Javadoc (#735)
---
fesod/src/main/java/org/apache/fesod/sheet/ExcelWriter.java | 2 +-
.../java/org/apache/fesod/sheet/annotation/ExcelProperty.java | 2 +-
.../main/java/org/apache/fesod/sheet/context/WriteContext.java | 4 ++--
.../sheet/converters/bigdecimal/BigDecimalBooleanConverter.java | 2 +-
.../sheet/write/builder/AbstractExcelWriterParameterBuilder.java | 8 ++++----
.../apache/fesod/sheet/write/metadata/WriteBasicParameter.java | 6 +++---
.../fesod/sheet/write/metadata/holder/AbstractWriteHolder.java | 6 +++---
.../org/apache/fesod/sheet/write/metadata/holder/WriteHolder.java | 6 ++----
8 files changed, 17 insertions(+), 19 deletions(-)
diff --git a/fesod/src/main/java/org/apache/fesod/sheet/ExcelWriter.java
b/fesod/src/main/java/org/apache/fesod/sheet/ExcelWriter.java
index e80c481a..d824bdc9 100644
--- a/fesod/src/main/java/org/apache/fesod/sheet/ExcelWriter.java
+++ b/fesod/src/main/java/org/apache/fesod/sheet/ExcelWriter.java
@@ -37,7 +37,7 @@ import org.apache.fesod.sheet.write.metadata.fill.FillConfig;
*
* <pre>
* 1. Create a new empty Excel workbook, write the value to the stream
after the value is filled.
- * 2. Edit existing Excel, write the original Excel file, or write it to
other places.}
+ * 2. Edit existing Excel, write the original Excel file, or write it to
other places.
* </pre>
*
*/
diff --git
a/fesod/src/main/java/org/apache/fesod/sheet/annotation/ExcelProperty.java
b/fesod/src/main/java/org/apache/fesod/sheet/annotation/ExcelProperty.java
index 9f9d058c..c6f2ea6e 100644
--- a/fesod/src/main/java/org/apache/fesod/sheet/annotation/ExcelProperty.java
+++ b/fesod/src/main/java/org/apache/fesod/sheet/annotation/ExcelProperty.java
@@ -59,7 +59,7 @@ public @interface ExcelProperty {
int index() default -1;
/**
- * Defines the sort order for an column.
+ * Defines the sort order for a column.
*
* priority: index > order > default sort
*
diff --git
a/fesod/src/main/java/org/apache/fesod/sheet/context/WriteContext.java
b/fesod/src/main/java/org/apache/fesod/sheet/context/WriteContext.java
index be60f905..d47f61c0 100644
--- a/fesod/src/main/java/org/apache/fesod/sheet/context/WriteContext.java
+++ b/fesod/src/main/java/org/apache/fesod/sheet/context/WriteContext.java
@@ -109,7 +109,7 @@ public interface WriteContext {
* Get outputStream
*
* @return
- * @deprecated please us e{@link #writeWorkbookHolder()} ()}
+ * @deprecated please use {@link #writeWorkbookHolder()}
*/
@Deprecated
OutputStream getOutputStream();
@@ -118,7 +118,7 @@ public interface WriteContext {
* Get workbook
*
* @return
- * @deprecated please us e{@link #writeWorkbookHolder()} ()}
+ * @deprecated please use {@link #writeWorkbookHolder()}
*/
@Deprecated
Workbook getWorkbook();
diff --git
a/fesod/src/main/java/org/apache/fesod/sheet/converters/bigdecimal/BigDecimalBooleanConverter.java
b/fesod/src/main/java/org/apache/fesod/sheet/converters/bigdecimal/BigDecimalBooleanConverter.java
index e85ba3d9..6054d1ae 100644
---
a/fesod/src/main/java/org/apache/fesod/sheet/converters/bigdecimal/BigDecimalBooleanConverter.java
+++
b/fesod/src/main/java/org/apache/fesod/sheet/converters/bigdecimal/BigDecimalBooleanConverter.java
@@ -31,7 +31,7 @@ import
org.apache.fesod.sheet.metadata.property.ExcelContentProperty;
* BigDecimal and boolean converter
*
* This converter is responsible for converting between Java type BigDecimal
and Excel's boolean type.
- * It treats Excel's true as BigDecimal.ONE, and false as BigDecimal.ZERO.
+ * It treats Excel's true as {@link BigDecimal#ONE}, and false as {@link
BigDecimal#ZERO}.
*
*
*/
diff --git
a/fesod/src/main/java/org/apache/fesod/sheet/write/builder/AbstractExcelWriterParameterBuilder.java
b/fesod/src/main/java/org/apache/fesod/sheet/write/builder/AbstractExcelWriterParameterBuilder.java
index e2ed55dd..40c8ad78 100644
---
a/fesod/src/main/java/org/apache/fesod/sheet/write/builder/AbstractExcelWriterParameterBuilder.java
+++
b/fesod/src/main/java/org/apache/fesod/sheet/write/builder/AbstractExcelWriterParameterBuilder.java
@@ -155,12 +155,12 @@ public abstract class AbstractExcelWriterParameterBuilder<
}
/**
- * Data will be order by {@link #includeColumnFieldNames} or {@link
#includeColumnIndexes}.
- *
- * default is false.
+ * Data will be ordered by {@link #includeColumnFieldNames} or {@link
#includeColumnIndexes}.
*
+ * @param orderByIncludeColumn {@code true} to order by included column;
default is {@code false}
+ * @return this
* @since 3.3.0
- **/
+ */
public T orderByIncludeColumn(Boolean orderByIncludeColumn) {
parameter().setOrderByIncludeColumn(orderByIncludeColumn);
return self();
diff --git
a/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/WriteBasicParameter.java
b/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/WriteBasicParameter.java
index c29cc477..1da4713e 100644
---
a/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/WriteBasicParameter.java
+++
b/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/WriteBasicParameter.java
@@ -81,9 +81,9 @@ public class WriteBasicParameter extends BasicParameter {
private Collection<String> includeColumnFieldNames;
/**
- * Data will be order by {@link #includeColumnFieldNames} or {@link
#includeColumnIndexes}.
- *
- * default is false.
+ * Data will be ordered by {@link #includeColumnFieldNames} or {@link
#includeColumnIndexes}.
+ * <p>
+ * Default is {@code false}.
*/
private Boolean orderByIncludeColumn;
}
diff --git
a/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/holder/AbstractWriteHolder.java
b/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/holder/AbstractWriteHolder.java
index eae8c3fd..80122ba2 100644
---
a/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/holder/AbstractWriteHolder.java
+++
b/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/holder/AbstractWriteHolder.java
@@ -117,9 +117,9 @@ public abstract class AbstractWriteHolder extends
AbstractHolder implements Writ
private Collection<String> includeColumnFieldNames;
/**
- * Data will be order by {@link #includeColumnFieldNames} or {@link
#includeColumnIndexes}.
- *
- * default is false.
+ * Data will be ordered by {@link #includeColumnFieldNames} or {@link
#includeColumnIndexes}.
+ * <p>
+ * Default is {@code false}.
*/
private Boolean orderByIncludeColumn;
diff --git
a/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/holder/WriteHolder.java
b/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/holder/WriteHolder.java
index b76ae88b..ebd749b6 100644
---
a/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/holder/WriteHolder.java
+++
b/fesod/src/main/java/org/apache/fesod/sheet/write/metadata/holder/WriteHolder.java
@@ -76,11 +76,9 @@ public interface WriteHolder extends ConfigurationHolder {
int relativeHeadRowIndex();
/**
- * Data will be order by {@link #includeColumnFieldNames} or {@link
#includeColumnIndexes}.
+ * Data will be ordered by {@link #includeColumnFieldNames} or {@link
#includeColumnIndexes}.
*
- * default is false.
- *
- * @return
+ * @return {@code true} to order by included column; default is {@code
false}
*/
boolean orderByIncludeColumn();
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
