mirror of https://github.com/apache/poi.git
Fix Javadocs
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1888935 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
7ab1c9c0fd
commit
9392b464e3
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -380,7 +380,8 @@ public final class BiffViewer {
|
|||
* BiffViewer [--biffhex] [--noint] [--noescher] [--out] <fileName><p>
|
||||
* BiffViewer --rawhex [--out] <fileName>
|
||||
*
|
||||
* <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 <fileName>.out</td></tr>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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 </th><th>Result </th><th>Comments</th></tr>
|
||||
* <tr><td>"A1" </td><td>true</td><td> </td></tr>
|
||||
* <tr><td>"a111" </td><td>true</td><td> </td></tr>
|
||||
|
@ -248,9 +248,9 @@ public final class SheetNameFormatter {
|
|||
* <tr><td>"A$1:$C$20" </td><td>false</td><td>Not a plain cell reference</td></tr>
|
||||
* <tr><td>"SALES20080101" </td><td>true</td>
|
||||
* <td>Still needs delimiting even though well out of range</td></tr>
|
||||
* </table></blockquote>
|
||||
* </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) {
|
||||
|
|
|
@ -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>
|
||||
|
|
Loading…
Reference in New Issue