From 9392b464e3b707b8ee544d0b03ffb106ea5ee0a8 Mon Sep 17 00:00:00 2001 From: Andreas Beeker Date: Sun, 18 Apr 2021 22:10:38 +0000 Subject: [PATCH] Fix Javadocs git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1888935 13f79535-47bb-0310-9956-ffa450edef68 --- .../poi/hslf/record/SSSlideInfoAtom.java | 3 +- .../poi/hwmf/record/HwmfBinaryRasterOp.java | 9 ++-- .../org/apache/poi/hwmf/record/HwmfMisc.java | 3 +- .../poi/hwmf/record/HwmfTernaryRasterOp.java | 9 ++-- .../poi/hpsf/wellknown/PropertyIDMap.java | 43 ++++++++++--------- .../org/apache/poi/hssf/dev/BiffViewer.java | 3 +- .../record/cont/ContinuableRecordOutput.java | 3 +- .../poi/ss/formula/SheetNameFormatter.java | 14 +++--- .../poi/ss/formula/functions/Match.java | 3 +- 9 files changed, 51 insertions(+), 39 deletions(-) diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/SSSlideInfoAtom.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/SSSlideInfoAtom.java index 0836ce98f1..2aa1cafc63 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/SSSlideInfoAtom.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/SSSlideInfoAtom.java @@ -38,7 +38,8 @@ import org.apache.poi.util.LittleEndianConsts; *
* * Combination of effectType and effectDirection: - * + *
+ * * * * diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfBinaryRasterOp.java b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfBinaryRasterOp.java index cf50d43719..75de4457b9 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfBinaryRasterOp.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfBinaryRasterOp.java @@ -29,14 +29,16 @@ import java.util.function.BiConsumer; * selected pen and the destination bitmap are combined. Following are the two operands used in these * operations. * - *
Combination of effectType and effectDirection
typedescriptiondirection
0cut0x00 = no transition, 0x01 = black transition
1random0x00
+ *
+ * * * * *
Raster-operation code meaning
OperandMeaning
PSelected pen
DDestination bitmap
* * Following are the Boolean operators used in these operations. - * + *
+ * * * * @@ -54,7 +56,8 @@ import java.util.function.BiConsumer; * (in this case, the pen and destination values). For example, the operation indexes for the DPo and * DPan operations are shown in the following list. * - *
Boolean operator meaning
OperandMeaning
aBitwise AND
nBitwise NOT (inverse)
+ *
+ * * * * diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfMisc.java b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfMisc.java index df252a35c1..dc307614ea 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfMisc.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfMisc.java @@ -756,7 +756,8 @@ public class HwmfMisc { * The following table shows the relationship between values in the BrushStyle, * ColorRef and BrushHatch fields in a LogBrush Object. Only supported brush styles are listed. * - *
Raster-operation examples
PDDPoDPan
0001
0111
+ *
+ * * * * diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfTernaryRasterOp.java b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfTernaryRasterOp.java index c84601e2b1..b9d9f7ed2b 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfTernaryRasterOp.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfTernaryRasterOp.java @@ -25,7 +25,8 @@ import java.util.Deque; * the source, the selected brush, and the destination are combined. Following are the three operands * used in these operations. * - *
Relationship between values in the BrushStyle, ColorRef and BrushHatch fields
BrushStyleColorRef
+ *
+ * * * * @@ -33,7 +34,8 @@ import java.util.Deque; *
Raster-operation code meaning
OperandMeaning
DDestination bitmap
PSelected brush (also called pattern)
* * Following are the Boolean operators used in these operations. - * + *
+ * * * * @@ -55,7 +57,8 @@ import java.util.Deque; * values. For example, the operation indexes for the PSo and DPSoo operations are shown in the * following list. * - *
Boolean operator meaning
OperandMeaning
aBitwise AND
nBitwise NOT (inverse)
+ *
+ * * * * diff --git a/poi/src/main/java/org/apache/poi/hpsf/wellknown/PropertyIDMap.java b/poi/src/main/java/org/apache/poi/hpsf/wellknown/PropertyIDMap.java index 6443c8c831..d2d6a01b8f 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/wellknown/PropertyIDMap.java +++ b/poi/src/main/java/org/apache/poi/hpsf/wellknown/PropertyIDMap.java @@ -108,7 +108,8 @@ public class PropertyIDMap implements Map { * document is allowed or whether is should be opened as read-only. It can * have the following values: * - *
Raster-operation examples
PSDDPoDPan
00000
00101
+ *
+ * * * * @@ -233,13 +234,13 @@ public class PropertyIDMap implements Map { * re-evaluated. */ public static final int PID_LINKSDIRTY = 0x10; - + /** - * The entry specifies an estimate of the number of characters + * The entry specifies an estimate of the number of characters * in the document, including whitespace, as an integer */ public static final int PID_CCHWITHSPACES = 0x11; - + // 0x12 Unused // 0x13 GKPIDDSI_SHAREDDOC - Must be False // 0x14 GKPIDDSI_LINKBASE - Must not be written @@ -251,46 +252,46 @@ public class PropertyIDMap implements Map { * hyperlinks should be updated on document load. */ public static final int PID_HYPERLINKSCHANGED = 0x16; - + /** * This entry contains the version of the Application which wrote the * Property set, stored with the two high order bytes having the major * version number, and the two low order bytes the minor version number. */ public static final int PID_VERSION = 0x17; - + /** - * This entry contains the VBA digital signature for the VBA project + * This entry contains the VBA digital signature for the VBA project * embedded in the document. */ public static final int PID_DIGSIG = 0x18; - + // 0x19 Unused - + /** * This entry contains a string of the content type of the file. */ public static final int PID_CONTENTTYPE = 0x1A; - + /** * This entry contains a string of the document status. */ public static final int PID_CONTENTSTATUS = 0x1B; - + /** * This entry contains a string of the document language, but * normally should be empty. */ public static final int PID_LANGUAGE = 0x1C; - + /** * This entry contains a string of the document version, but * normally should be empty */ public static final int PID_DOCVERSION = 0x1D; - + /** - * The highest well-known property ID. Applications are free to use + * The highest well-known property ID. Applications are free to use * higher values for custom purposes. (This value is based on Office 12, * earlier versions of Office had lower values) */ @@ -311,19 +312,19 @@ public class PropertyIDMap implements Map { * A version 0 property set, indicated by the value 0x0000 for the Version field of * the PropertySetStream packet, MUST NOT have a Behavior property. * If the Behavior property is present, it MUST have one of the following values. - * + * *
    *
  • 0x00000000 = Property names are case-insensitive (default) *
  • 0x00000001 = Property names are case-sensitive. *
*/ public static final int PID_BEHAVIOUR = 0x80000003; - + /** * A property without a known name is described by this string. */ public static final String UNDEFINED = "[undefined]"; - + /** * Contains the summary information property ID values and * associated strings. See the overall HPSF documentation for @@ -376,8 +377,8 @@ public class PropertyIDMap implements Map { { (long)PID_COMPANY, "PID_COMPANY" }, { (long)PID_LINKSDIRTY, "PID_LINKSDIRTY" }, }; - - + + /** * Contains the fallback property ID values and associated strings. * This is only used for lookups and not for initializing a property set @@ -420,7 +421,7 @@ public class PropertyIDMap implements Map { }; private final Map idMap; - + /** * Creates a {@link PropertyIDMap} backed by another map. @@ -467,7 +468,7 @@ public class PropertyIDMap implements Map { } return fallbackProperties; } - + @Override public int size() { return idMap.size(); diff --git a/poi/src/main/java/org/apache/poi/hssf/dev/BiffViewer.java b/poi/src/main/java/org/apache/poi/hssf/dev/BiffViewer.java index 10d59c869c..1f15da7578 100644 --- a/poi/src/main/java/org/apache/poi/hssf/dev/BiffViewer.java +++ b/poi/src/main/java/org/apache/poi/hssf/dev/BiffViewer.java @@ -380,7 +380,8 @@ public final class BiffViewer { * BiffViewer [--biffhex] [--noint] [--noescher] [--out] <fileName>

* BiffViewer --rawhex [--out] <fileName> * - *

ID-property mapping
Value
+ *
+ * * * * diff --git a/poi/src/main/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java b/poi/src/main/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java index 274ffe96d1..38857289c7 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java @@ -123,7 +123,8 @@ public final class ContinuableRecordOutput implements LittleEndianOutput { * * * The following bits of the 'optionFlags' byte will be set as appropriate: - *
BiffViewer options
--biffhexshow hex dump of each BIFF record
--nointdo not output interpretation of BIFF records
--outsend output to <fileName>.out
+ *
+ * * * * diff --git a/poi/src/main/java/org/apache/poi/ss/formula/SheetNameFormatter.java b/poi/src/main/java/org/apache/poi/ss/formula/SheetNameFormatter.java index 8f92043a5e..9e847ebdc1 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/SheetNameFormatter.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/SheetNameFormatter.java @@ -180,7 +180,7 @@ public final class SheetNameFormatter { } /** - * @return true if the presence of the specified character in a sheet name would + * @return {@code true} if the presence of the specified character in a sheet name would * require the sheet name to be delimited in formulas. This includes every non-alphanumeric * character besides underscore '_' and dot '.'. */ @@ -207,7 +207,7 @@ public final class SheetNameFormatter { * Used to decide whether sheet names like 'AB123' need delimiting due to the fact that they * look like cell references. *

- * This code is currently being used for translating formulas represented with Ptg + * This code is currently being used for translating formulas represented with {@code Ptg} * tokens into human readable text form. In formula expressions, a sheet name always has a * trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this * method returns but it is worth noting the likely consumers of these formula text strings: @@ -236,8 +236,8 @@ public final class SheetNameFormatter { * cannot be used to match absolute or range references (using the dollar or colon char). *

* Some notable cases: - *

bits of the 'optionFlags'
MaskDescription
0x01is16bitEncoded
0x04hasExtendedData
+ *
+ * * * * @@ -247,10 +247,10 @@ public final class SheetNameFormatter { * * * - * - *
Notable cases
Input Result Comments
"A1"  true 
"a111"  true 
"A1A1"  false 
"A$1:$C$20"  falseNot a plain cell reference
"SALES20080101"  trueStill needs delimiting even though well out of range
+ * Still needs delimiting even though well out of range + * * - * @return true if there is any possible ambiguity that the specified rawSheetName + * @return {@code true} if there is any possible ambiguity that the specified rawSheetName * could be interpreted as a valid cell name. */ /* package */ static boolean nameLooksLikePlainCellReference(String rawSheetName) { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/Match.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/Match.java index 96dd7a3972..260d2c9452 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/functions/Match.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/Match.java @@ -43,7 +43,8 @@ import org.apache.poi.ss.formula.functions.LookupUtils.ValueVector; * * Specific matching behaviour can be modified with the optional match_type parameter. * - * + *
+ * * *
match_type parameter description
ValueMatching Behaviour
1(default) find the largest value that is less than or equal to lookup_value. * The lookup_array must be in ascending order*.