]> source.dussan.org Git - poi.git/commitdiff
Fix Javadocs
authorAndreas Beeker <kiwiwings@apache.org>
Sun, 18 Apr 2021 22:10:38 +0000 (22:10 +0000)
committerAndreas Beeker <kiwiwings@apache.org>
Sun, 18 Apr 2021 22:10:38 +0000 (22:10 +0000)
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1888935 13f79535-47bb-0310-9956-ffa450edef68

poi-scratchpad/src/main/java/org/apache/poi/hslf/record/SSSlideInfoAtom.java
poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfBinaryRasterOp.java
poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfMisc.java
poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfTernaryRasterOp.java
poi/src/main/java/org/apache/poi/hpsf/wellknown/PropertyIDMap.java
poi/src/main/java/org/apache/poi/hssf/dev/BiffViewer.java
poi/src/main/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java
poi/src/main/java/org/apache/poi/ss/formula/SheetNameFormatter.java
poi/src/main/java/org/apache/poi/ss/formula/functions/Match.java

index 0836ce98f14d4957eb95541520e40e386f509c14..2aa1cafc6322972b8f22ae3bad33737cc86a66e6 100644 (file)
@@ -38,7 +38,8 @@ import org.apache.poi.util.LittleEndianConsts;
  * <br>
  *
  * Combination of effectType and effectDirection:
- * <table summary="">
+ * <table>
+ * <caption>Combination of effectType and effectDirection</caption>
  * <tr><th>type</th><th>description</th><th>direction</th></tr>
  * <tr><td>0</td><td>cut</td><td>0x00 = no transition, 0x01 = black transition</td></tr>
  * <tr><td>1</td><td>random</td><td>0x00</td></tr>
index cf50d4371981335e1b3dffb753b8bd27d7b70e36..75de4457b998057b6f61a016e6aab6ac57c8227e 100644 (file)
@@ -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.
  *
- * <table summary="">
+ * <table>
+ * <caption>Raster-operation code meaning</caption>
  * <tr><th>Operand</th><th>Meaning</th></tr>
  * <tr><td>P</td><td>Selected pen</td></tr>
  * <tr><td>D</td><td>Destination bitmap</td></tr>
  * </table>
  *
  * Following are the Boolean operators used in these operations.
- * <table summary="">
+ * <table>
+ * <caption>Boolean operator meaning</caption>
  * <tr><th>Operand</th><th>Meaning</th></tr>
  * <tr><td>a</td><td>Bitwise AND</td></tr>
  * <tr><td>n</td><td>Bitwise NOT (inverse)</td></tr>
@@ -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.
  *
- * <table summary="">
+ * <table>
+ * <caption>Raster-operation examples</caption>
  * <tr><th>P</th><th>D</th><th>DPo</th><th>DPan</th></tr>
  * <tr><td>0</td><td>0</td><td>0</td><td>1</td></tr>
  * <tr><td>0</td><td>1</td><td>1</td><td>1</td></tr>
index df252a35c1a71a59e9816313260dcbca165e27da..dc307614ea681521a216d8dc0ce1d4f8b7110c1f 100644 (file)
@@ -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.
      *
-     * <table summary="">
+     * <table>
+     * <caption>Relationship between values in the BrushStyle, ColorRef and BrushHatch fields</caption>
      * <tr>
      *   <th>BrushStyle</th>
      *   <th>ColorRef</th>
index c84601e2b11bb32e357be0ef5ab9069b925abb79..b9d9f7ed2b3ac1d0a49a63d646bf88cc2237101e 100644 (file)
@@ -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.
  *
- * <table summary="">
+ * <table>
+ * <caption>Raster-operation code meaning</caption>
  * <tr><th>Operand</th><th>Meaning</th></tr>
  * <tr><td>D</td><td>Destination bitmap</td></tr>
  * <tr><td>P</td><td>Selected brush (also called pattern)</td></tr>
@@ -33,7 +34,8 @@ import java.util.Deque;
  * </table>
  *
  * Following are the Boolean operators used in these operations.
- * <table summary="">
+ * <table>
+ * <caption>Boolean operator meaning</caption>
  * <tr><th>Operand</th><th>Meaning</th></tr>
  * <tr><td>a</td><td>Bitwise AND</td></tr>
  * <tr><td>n</td><td>Bitwise NOT (inverse)</td></tr>
@@ -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.
  *
- * <table summary="">
+ * <table>
+ * <caption>Raster-operation examples</caption>
  * <tr><th>P</th><th>S</th><th>D</th><th>DPo</th><th>DPan</th></tr>
  * <tr><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td></tr>
  * <tr><td>0</td><td>0</td><td>1</td><td>0</td><td>1</td></tr>
index 6443c8c831549184f1a25a3210a67ed16f3fef8c..d2d6a01b8f26fe03ebb658231ebcb3e04bab5668 100644 (file)
@@ -108,7 +108,8 @@ public class PropertyIDMap implements Map<Long,String> {
      * document is allowed or whether is should be opened as read-only. It can
      * have the following values:
      *
-     * <table summary="">
+     * <table>
+     *  <caption>ID-property mapping</caption>
      *  <tbody>
      *   <tr>
      *    <th>Value</th>
@@ -233,13 +234,13 @@ public class PropertyIDMap implements Map<Long,String> {
      * 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<Long,String> {
      *  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<Long,String> {
      * 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.
-     * 
+     *
      * <ul>
      * <li>0x00000000 = Property names are case-insensitive (default)
      * <li>0x00000001 = Property names are case-sensitive.
      * </ul>
      */
     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,String> {
         { (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<Long,String> {
     };
 
     private final Map<Long,String> idMap;
-    
+
 
     /**
      * Creates a {@link PropertyIDMap} backed by another map.
@@ -467,7 +468,7 @@ public class PropertyIDMap implements Map<Long,String> {
         }
         return fallbackProperties;
     }
-    
+
     @Override
     public int size() {
         return idMap.size();
index 10d59c869c6355206f3412fe9dcde97b3b2c1f1a..1f15da75783b1e99868893c72c0d9dc3b3bb562e 100644 (file)
@@ -380,7 +380,8 @@ public final class BiffViewer {
         * BiffViewer [--biffhex] [--noint] [--noescher] [--out] &lt;fileName&gt;<p>
         * BiffViewer --rawhex  [--out] &lt;fileName&gt;
         *
-        * <table summary="BiffViewer options">
+        * <table>
+     * <caption>BiffViewer options</caption>
         * <tr><td>--biffhex</td><td>show hex dump of each BIFF record</td></tr>
         * <tr><td>--noint</td><td>do not output interpretation of BIFF records</td></tr>
         * <tr><td>--out</td><td>send output to &lt;fileName&gt;.out</td></tr>
index 274ffe96d1b3e39aab724bb8f5759d37f2881388..38857289c77d730c0d3793048e8b2552c12a83d7 100644 (file)
@@ -123,7 +123,8 @@ public final class ContinuableRecordOutput implements LittleEndianOutput {
         * </ul>
         *
         * The following bits of the 'optionFlags' byte will be set as appropriate:
-        * <table border='1'>
+        * <table>
+        * <caption>bits of the 'optionFlags'</caption>
         * <tr><th>Mask</th><th>Description</th></tr>
         * <tr><td>0x01</td><td>is16bitEncoded</td></tr>
         * <tr><td>0x04</td><td>hasExtendedData</td></tr>
index 8f92043a5ece15d0c74051dd78f76f0c2fb26b8c..9e847ebdc1be3243ed293caf308e5f00c1481786 100644 (file)
@@ -180,7 +180,7 @@ public final class SheetNameFormatter {
        }
 
        /**
-        * @return <code>true</code> 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.
         * <p>
-        * This code is currently being used for translating formulas represented with <code>Ptg</code>
+        * 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).
         * <p>
         * Some notable cases:
-        *    <blockquote><table border="0" cellpadding="1" cellspacing="0"
-        *                 summary="Notable cases.">
+        *    <table>
+        *      <caption>Notable cases</caption>
         *      <tr><th>Input&nbsp;</th><th>Result&nbsp;</th><th>Comments</th></tr>
         *      <tr><td>"A1"&nbsp;&nbsp;</td><td>true</td><td>&nbsp;</td></tr>
         *      <tr><td>"a111"&nbsp;&nbsp;</td><td>true</td><td>&nbsp;</td></tr>
@@ -247,10 +247,10 @@ public final class SheetNameFormatter {
         *      <tr><td>"A1A1"&nbsp;&nbsp;</td><td>false</td><td>&nbsp;</td></tr>
         *      <tr><td>"A$1:$C$20"&nbsp;&nbsp;</td><td>false</td><td>Not a plain cell reference</td></tr>
         *      <tr><td>"SALES20080101"&nbsp;&nbsp;</td><td>true</td>
-        *                      <td>Still needs delimiting even though well out of range</td></tr>
-        *    </table></blockquote>
+        *      <td>Still needs delimiting even though well out of range</td></tr>
+        *    </table>
         *
-        * @return <code>true</code> 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) {
index 96dd7a3972c49b43786918d8e1a4c35fe8c87aaf..260d2c94527393ea8655d5d09c52b76f7a9b14ea 100644 (file)
@@ -43,7 +43,8 @@ import org.apache.poi.ss.formula.functions.LookupUtils.ValueVector;
  *
  * Specific matching behaviour can be modified with the optional <b>match_type</b> parameter.
  *
- *    <table border="0" cellpadding="1" cellspacing="0" summary="match_type parameter description">
+ *    <table>
+ *      <caption>match_type parameter description</caption>
  *      <tr><th>Value</th><th>Matching Behaviour</th></tr>
  *      <tr><td>1</td><td>(default) find the largest value that is less than or equal to lookup_value.
  *        The lookup_array must be in ascending <i>order</i>*.</td></tr>