mirror of https://github.com/apache/poi.git
cleaned javadocs warnings
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1132549 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yegor Kozlov
parent
6aa2008c97
commit
8b85912bed
|
|
@ -266,7 +266,6 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss
|
|||
* low level models. If you're reading in a workbook...start here.
|
||||
*
|
||||
* @param directory the POI filesystem directory to process from
|
||||
* @param fs the POI filesystem that contains the Workbook stream.
|
||||
* @param preserveNodes whether to preseve other nodes, such as
|
||||
* macros. This takes more memory, so only say yes if you
|
||||
* need to. If set, will store all of the POIFSFileSystem
|
||||
|
|
|
|||
|
|
@ -180,7 +180,7 @@ public class DirectoryNode
|
|||
/**
|
||||
* open a document in the directory's entry's list of entries
|
||||
*
|
||||
* @param documentEntry the document to be opened
|
||||
* @param document the document to be opened
|
||||
*
|
||||
* @return a newly opened DocumentInputStream or NDocumentInputStream
|
||||
*
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ public abstract class PropertyTableBase implements BATManaged {
|
|||
* to extract the property table from it). Populates the
|
||||
* properties thoroughly
|
||||
*
|
||||
* @param startBlock the first block of the property table
|
||||
* @param blockList the list of blocks
|
||||
* @param header_block the first block to read from
|
||||
* @param properties the list to populate
|
||||
*
|
||||
* @exception IOException if anything goes wrong (which should be
|
||||
* a result of the input being NFG)
|
||||
|
|
|
|||
|
|
@ -75,7 +75,7 @@ public final class Irr implements Function {
|
|||
* </p>
|
||||
* <p>
|
||||
* The implementation is inspired by the NewtonSolver from the Apache Commons-Math library,
|
||||
* @see {http://commons.apache.org/}
|
||||
* @see <a href="http://commons.apache.org">http://commons.apache.org</a>
|
||||
* </p>
|
||||
*
|
||||
* @param values the income values.
|
||||
|
|
@ -83,8 +83,10 @@ public final class Irr implements Function {
|
|||
* @return the irr value. The method returns <code>Double.NaN</code>
|
||||
* if the maximum iteration count is exceeded
|
||||
*
|
||||
* @see {http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution}
|
||||
* @see {http://en.wikipedia.org/wiki/Newton%27s_method}
|
||||
* @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">
|
||||
* http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution</a>
|
||||
* @see <a href="http://en.wikipedia.org/wiki/Newton%27s_method">
|
||||
* http://en.wikipedia.org/wiki/Newton%27s_method</a>
|
||||
*/
|
||||
public static double irr(double[] values, double guess) {
|
||||
int maxIterationCount = 20;
|
||||
|
|
|
|||
|
|
@ -556,9 +556,6 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
|
|||
return retArr;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return
|
||||
*/
|
||||
public List<PackagePart> getPartsByName(final Pattern namePattern) {
|
||||
if (namePattern == null) {
|
||||
throw new IllegalArgumentException("name pattern must not be null");
|
||||
|
|
|
|||
|
|
@ -495,7 +495,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
|
|||
}
|
||||
|
||||
/**
|
||||
* add a new paragraph at position of the cursor. The cursor must be on the
|
||||
* Add a new paragraph at position of the cursor. The cursor must be on the
|
||||
* {@link TokenType#START} tag of an subelement of the documents body. When
|
||||
* this method is done, the cursor passed as parameter points to the
|
||||
* {@link TokenType#END} of the newly inserted paragraph.
|
||||
|
|
|
|||
|
|
@ -226,7 +226,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
|
|||
/**
|
||||
* Adds a picture to the document.
|
||||
*
|
||||
* @param is The stream to read image from
|
||||
* @param pictureData The picture data
|
||||
* @param format The format of the picture.
|
||||
*
|
||||
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} .
|
||||
|
|
|
|||
|
|
@ -166,7 +166,7 @@ public class XWPFNumbering extends POIXMLDocumentPart {
|
|||
|
||||
/**
|
||||
* Add a new num with an abstractNumID and a numID
|
||||
* @param abstractNumId
|
||||
* @param abstractNumID
|
||||
* @param numID
|
||||
*/
|
||||
public void addNum(BigInteger abstractNumID, BigInteger numID){
|
||||
|
|
|
|||
|
|
@ -1270,7 +1270,6 @@ public class XWPFParagraph implements IBodyElement {
|
|||
* adds a new Run to the Paragraph
|
||||
*
|
||||
* @param r
|
||||
* @return
|
||||
*/
|
||||
public void addRun(XWPFRun r) {
|
||||
if (!runs.contains(r)) {
|
||||
|
|
@ -1282,7 +1281,6 @@ public class XWPFParagraph implements IBodyElement {
|
|||
* return the XWPFRun-Element which owns the CTR run-Element
|
||||
*
|
||||
* @param r
|
||||
* @return
|
||||
*/
|
||||
public XWPFRun getRun(CTR r) {
|
||||
for (int i = 0; i < getRuns().size(); i++) {
|
||||
|
|
|
|||
|
|
@ -87,7 +87,6 @@ public class XWPFSettings extends POIXMLDocumentPart {
|
|||
* <pre>
|
||||
* <w:zoom w:percent="50" />
|
||||
* <pre>
|
||||
* @return percentage as an integer of zoom level
|
||||
*/
|
||||
public void setZoomPercent(long zoomPercent) {
|
||||
if (! ctSettings.isSetZoom()) {
|
||||
|
|
|
|||
|
|
@ -118,7 +118,6 @@ public class MAPIMessage extends POIDocument {
|
|||
* Constructor for reading MSG Files from a certain
|
||||
* point within a POIFS filesystem
|
||||
* @param poifsDir
|
||||
* @param fs
|
||||
* @throws IOException
|
||||
*/
|
||||
public MAPIMessage(DirectoryNode poifsDir) throws IOException {
|
||||
|
|
|
|||
|
|
@ -152,7 +152,7 @@ public final class HWPFDocument extends HWPFDocumentCore
|
|||
* in a POIFSFileSystem, probably not the default.
|
||||
* Used typically to open embeded documents.
|
||||
*
|
||||
* @param pfilesystem The POIFSFileSystem that contains the Word document.
|
||||
* @param directory The DirectoryNode that contains the Word document.
|
||||
* @throws IOException If there is an unexpected IOException from the passed
|
||||
* in POIFSFileSystem.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -126,7 +126,7 @@ public abstract class HWPFDocumentCore extends POIDocument
|
|||
* in a POIFSFileSystem, probably not the default.
|
||||
* Used typically to open embeded documents.
|
||||
*
|
||||
* @param pfilesystem The POIFSFileSystem that contains the Word document.
|
||||
* @param directory The DirectoryNode that contains the Word document.
|
||||
* @throws IOException If there is an unexpected IOException from the passed
|
||||
* in POIFSFileSystem.
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue