This is an automated email from the ASF dual-hosted git repository. centic pushed a commit to branch trunk in repository https://gitbox.apache.org/repos/asf/poi.git
commit 97a97bd75c22f081cc4a2d7a0974d4aa64edf1c8 Author: Dominik Stadler <[email protected]> AuthorDate: Wed Dec 17 20:35:11 2025 +0100 JavaDoc: Don't link to classes from "poi-ooxml" in module "poi" Otherwise building javadoc in CI fails sometimes, maybe if the repository is cleaned before building. And add some missing javadoc --- poi/src/main/java/org/apache/poi/POIDocument.java | 1 + .../java/org/apache/poi/extractor/ExtractorFactory.java | 6 +++--- .../main/java/org/apache/poi/sl/usermodel/SlideShow.java | 2 +- .../apache/poi/ss/formula/eval/forked/ForkedEvaluator.java | 2 +- .../java/org/apache/poi/ss/usermodel/ExtendedColor.java | 2 +- .../org/apache/poi/ss/usermodel/helpers/RowShifter.java | 14 +++++++------- 6 files changed, 14 insertions(+), 13 deletions(-) diff --git a/poi/src/main/java/org/apache/poi/POIDocument.java b/poi/src/main/java/org/apache/poi/POIDocument.java index 0f4239bb82..c563d64113 100644 --- a/poi/src/main/java/org/apache/poi/POIDocument.java +++ b/poi/src/main/java/org/apache/poi/POIDocument.java @@ -473,6 +473,7 @@ public abstract class POIDocument implements Closeable { * to a new POIFSFileSystem * * @param newDirectory the new directory + * @throws IOException if accessing the file-system fails. */ @Internal protected void replaceDirectory(DirectoryNode newDirectory) throws IOException { diff --git a/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java b/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java index 2b8ca5a450..458c4ed65c 100644 --- a/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java +++ b/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java @@ -47,7 +47,7 @@ import org.apache.poi.util.ThreadLocalUtil; * <p>Note 1 - will fail for many file formats if the POI Scratchpad jar is * not present on the runtime classpath</p> * <p>Note 2 - for text extractor creation across all formats, use - * {@link org.apache.poi.ooxml.extractor.POIXMLExtractorFactory} contained within + * org.apache.poi.ooxml.extractor.POIXMLExtractorFactory contained within * the OOXML jar.</p> * <p>Note 3 - rather than using this, for most cases you would be better * off switching to <a href="http://tika.apache.org";>Apache Tika</a> instead!</p> @@ -294,7 +294,7 @@ public final class ExtractorFactory { /** * Create the Extractor, if possible. Generally needs the Scratchpad jar. * Note that this won't check for embedded OOXML resources either, use - * {@link org.apache.poi.ooxml.extractor.POIXMLExtractorFactory} for that. + * org.apache.poi.ooxml.extractor.POIXMLExtractorFactory for that. * * @param root The {@link DirectoryNode} pointing to a document. * @@ -313,7 +313,7 @@ public final class ExtractorFactory { /** * Create the Extractor, if possible. Generally needs the Scratchpad jar. * Note that this won't check for embedded OOXML resources either, use - * {@link org.apache.poi.ooxml.extractor.POIXMLExtractorFactory} for that. + * org.apache.poi.ooxml.extractor.POIXMLExtractorFactory for that. * * @param root The {@link DirectoryNode} pointing to a document. * @param password The password that is necessary to open the file diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/SlideShow.java b/poi/src/main/java/org/apache/poi/sl/usermodel/SlideShow.java index e29cb4a381..38ca6821ee 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/SlideShow.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/SlideShow.java @@ -130,7 +130,7 @@ public interface SlideShow< /** * @return the instance which handles the persisting of the slideshow, * which is either a subclass of {@link org.apache.poi.POIDocument} - * or {@link org.apache.poi.ooxml.POIXMLDocument} + * or org.apache.poi.ooxml.POIXMLDocument * * @since 4.0.0 */ diff --git a/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java b/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java index 0b6e2b17bc..a78c636fa8 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java @@ -36,7 +36,7 @@ import org.apache.poi.ss.usermodel.Workbook; /** * An alternative workbook evaluator that saves memory in situations where a single workbook is * concurrently and independently evaluated many times. With standard formula evaluation, around - * 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link org.apache.poi.xssf.usermodel.XSSFWorkbook}. + * 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or org.apache.poi.xssf.usermodel.XSSFWorkbook. * This class enables a 'master workbook' to be loaded just once and shared between many evaluation * clients. Each evaluation client creates its own {@link ForkedEvaluator} and can set cell values * that will be used for local evaluations (and don't disturb evaluations on other evaluators). diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/ExtendedColor.java b/poi/src/main/java/org/apache/poi/ss/usermodel/ExtendedColor.java index ed932b13f3..5c4ca62e74 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/ExtendedColor.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/ExtendedColor.java @@ -20,7 +20,7 @@ import java.util.Locale; /** * Represents a XSSF-style color (based on either a - * {@link org.apache.poi.xssf.usermodel.XSSFColor} or a + * org.apache.poi.xssf.usermodel.XSSFColor or a * {@link org.apache.poi.hssf.record.common.ExtendedColor} */ public abstract class ExtendedColor implements Color { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/RowShifter.java b/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/RowShifter.java index 2ef2921e07..7833100c20 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/RowShifter.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/RowShifter.java @@ -30,16 +30,16 @@ import org.apache.poi.util.LocaleUtil; * Helper for shifting rows up or down */ // non-Javadoc: This abstract class exists to consolidate duplicated code between -// {@link org.apache.poi.hssf.usermodel.helpers.HSSFRowShifter} and -// {@link org.apache.poi.xssf.usermodel.helpers.XSSFRowShifter} +// org.apache.poi.hssf.usermodel.helpers.HSSFRowShifter and +// org.apache.poi.xssf.usermodel.helpers.XSSFRowShifter // (currently methods sprinkled throughout HSSFSheet) public abstract class RowShifter extends BaseRowColShifter { protected final Sheet sheet; - public RowShifter(Sheet sh) { - sheet = sh; - } - + public RowShifter(Sheet sh) { + sheet = sh; + } + /** * Shifts, grows, or shrinks the merged regions due to a row shift. * Merged regions that are completely overlaid by shifting will be deleted. @@ -83,7 +83,7 @@ public abstract class RowShifter extends BaseRowColShifter { removedIndices.add(i); } } - + if(!removedIndices.isEmpty()) { sheet.removeMergedRegions(removedIndices); } --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
