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
This commit is contained in:
Dominik Stadler 2025-12-17 20:35:11 +01:00
parent 338882ac88
commit 97a97bd75c
6 changed files with 14 additions and 13 deletions

View File

@ -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 {

View File

@ -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

View File

@ -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
*/

View File

@ -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).

View File

@ -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 {

View File

@ -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);
}