From: Yegor Kozlov Date: Fri, 9 Dec 2011 16:48:38 +0000 (+0000) Subject: fixed javadoc warnings X-Git-Tag: REL_3_8_BETA5~3 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=217dbe5502956535f4f9349fe673ebd3258b752a;p=poi.git fixed javadoc warnings git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1212511 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/java/org/apache/poi/POIDocument.java b/src/java/org/apache/poi/POIDocument.java index e7ec12a581..169e9241bc 100644 --- a/src/java/org/apache/poi/POIDocument.java +++ b/src/java/org/apache/poi/POIDocument.java @@ -245,8 +245,8 @@ public abstract class POIDocument { /** * Copies nodes from one POIFS to the other minus the excepts - * @param source is the source POIFS to copy from - * @param target is the target POIFS to copy to + * @param sourceRoot is the source POIFS to copy from + * @param targetRoot is the target POIFS to copy to * @param excepts is a list of Strings specifying what nodes NOT to copy */ @Deprecated diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java index c0af3dda54..a208b2eb21 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java @@ -547,9 +547,8 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss * @param sheetIx number (0 based) * @throws IllegalArgumentException if the name is null or invalid * or workbook already contains a sheet with this name - * @see {@link #createSheet(String)} - * @see {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} - * for a safe way to create valid names + * @see #createSheet(String) + * @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal) */ public void setSheetName(int sheetIx, String name) { if (name == null) { @@ -781,8 +780,7 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss * @return Sheet representing the new sheet. * @throws IllegalArgumentException if the name is null or invalid * or workbook already contains a sheet with this name - * @see {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} - * for a safe way to create valid names + * @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal) */ public HSSFSheet createSheet(String sheetname) { diff --git a/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java b/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java index 2c9308bfe8..3233dfa260 100644 --- a/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java +++ b/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java @@ -61,12 +61,10 @@ public class EntryUtils /** * Copies all the nodes from one POIFS Directory to another * - * @param source + * @param sourceRoot * is the source Directory to copy from - * @param target + * @param targetRoot * is the target Directory to copy to - * @param excepts - * is a list of Strings specifying what nodes NOT to copy */ public static void copyNodes(DirectoryEntry sourceRoot, DirectoryEntry targetRoot) throws IOException @@ -79,8 +77,8 @@ public class EntryUtils /** * Copies nodes from one Directory to the other minus the excepts * - * @param source The filtering source Directory to copy from - * @param target The filtering target Directory to copy to + * @param filteredSource The filtering source Directory to copy from + * @param filteredTarget The filtering target Directory to copy to */ public static void copyNodes( FilteringDirectoryNode filteredSource, FilteringDirectoryNode filteredTarget ) throws IOException @@ -93,9 +91,9 @@ public class EntryUtils /** * Copies nodes from one Directory to the other minus the excepts * - * @param source + * @param sourceRoot * is the source Directory to copy from - * @param target + * @param targetRoot * is the target Directory to copy to * @param excepts * is a list of Strings specifying what nodes NOT to copy diff --git a/src/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java b/src/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java index 737f8d97c5..861768aee7 100644 --- a/src/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java +++ b/src/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java @@ -57,7 +57,7 @@ public class FilteringDirectoryNode implements DirectoryEntry * will exclude entries such as "MyNode" and "MyDir/IgnoreNode". * The excludes can stretch into children, if they contain a /. * - * @param entry The Directory to filter + * @param directory The Directory to filter * @param excludes The Entries to exclude */ public FilteringDirectoryNode(DirectoryEntry directory, Collection excludes) { diff --git a/src/java/org/apache/poi/poifs/filesystem/Ole10Native.java b/src/java/org/apache/poi/poifs/filesystem/Ole10Native.java index db05d97d9f..1ef66d5e7c 100644 --- a/src/java/org/apache/poi/poifs/filesystem/Ole10Native.java +++ b/src/java/org/apache/poi/poifs/filesystem/Ole10Native.java @@ -66,7 +66,7 @@ public class Ole10Native { * to include a stream "{01}Ole10Native" which contains the actual * data relevant for this class. * - * @param poifs POI Filesystem object + * @param directory POI Filesystem object * @return Returns an instance of this class * @throws IOException on IO error * @throws Ole10NativeException on invalid or unexcepted data format diff --git a/src/java/org/apache/poi/ss/usermodel/ConditionalFormatting.java b/src/java/org/apache/poi/ss/usermodel/ConditionalFormatting.java index 8b117ce31b..674c0470be 100644 --- a/src/java/org/apache/poi/ss/usermodel/ConditionalFormatting.java +++ b/src/java/org/apache/poi/ss/usermodel/ConditionalFormatting.java @@ -44,7 +44,8 @@ import org.apache.poi.ss.util.CellRangeAddress; * * * - * Use {@link org.apache.poi.hssf.usermodel.Sheet#getSheetConditionalFormatting()} to get access to an instance of this class. + * Use {@link org.apache.poi.ss.usermodel.Sheet#getSheetConditionalFormatting()} + * to get access to an instance of this class. *

* To create a new Conditional Formatting set use the following approach: * diff --git a/src/java/org/apache/poi/ss/usermodel/SheetConditionalFormatting.java b/src/java/org/apache/poi/ss/usermodel/SheetConditionalFormatting.java index 37387c8da1..e20a8f74b6 100644 --- a/src/java/org/apache/poi/ss/usermodel/SheetConditionalFormatting.java +++ b/src/java/org/apache/poi/ss/usermodel/SheetConditionalFormatting.java @@ -46,7 +46,7 @@ public interface SheetConditionalFormatting { * * @param regions - list of rectangular regions to apply conditional formatting rules * @param rule1 - the first rule - * @param rule1 - the second rule + * @param rule2 - the second rule * * @return index of the newly created Conditional Formatting object */ diff --git a/src/java/org/apache/poi/ss/usermodel/Workbook.java b/src/java/org/apache/poi/ss/usermodel/Workbook.java index 3ee44fdc1f..ce117f4cde 100644 --- a/src/java/org/apache/poi/ss/usermodel/Workbook.java +++ b/src/java/org/apache/poi/ss/usermodel/Workbook.java @@ -129,13 +129,15 @@ public interface Workbook { /** * Set the sheet name. - * + *

+ * See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} + * for a safe way to create valid names + *

* @param sheet number (0 based) * @throws IllegalArgumentException if the name is null or invalid * or workbook already contains a sheet with this name - * @see {@link #createSheet(String)} - * @see {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} - * for a safe way to create valid names + * @see #createSheet(String) + * @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal) */ void setSheetName(int sheet, String name); @@ -208,12 +210,15 @@ public interface Workbook { * The string MUST NOT begin or end with the single quote (') character. *

* + *

+ * See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} + * for a safe way to create valid names + *

* @param sheetname sheetname to set for the sheet. * @return Sheet representing the new sheet. * @throws IllegalArgumentException if the name is null or invalid * or workbook already contains a sheet with this name - * @see {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} - * for a safe way to create valid names + * @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal) */ Sheet createSheet(String sheetname); diff --git a/src/java/org/apache/poi/util/LittleEndian.java b/src/java/org/apache/poi/util/LittleEndian.java index bf654baa07..c07c4beb30 100644 --- a/src/java/org/apache/poi/util/LittleEndian.java +++ b/src/java/org/apache/poi/util/LittleEndian.java @@ -573,7 +573,7 @@ public class LittleEndian implements LittleEndianConsts * * @param data * the byte array - * @param offset + * @param startOffset * a starting offset into the byte array * @param value * the short (16-bit) values diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java index b46ae8b2bc..1d3ed4e11e 100644 --- a/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java +++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java @@ -65,7 +65,6 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.Comparator; -import java.util.List; /** * Encapsulates logic to translate DrawingML objects to Java2D @@ -142,10 +141,10 @@ class RenderableShape { String blipId = blip.getEmbed(); PackageRelationship rel = parentPart.getRelationship(blipId); if (rel != null) { - XSLFImageRendener renderer = null; + XSLFImageRenderer renderer = null; if (graphics != null) - renderer = (XSLFImageRendener) graphics.getRenderingHint(XSLFRenderingHint.IMAGE_RENDERER); - if (renderer == null) renderer = new XSLFImageRendener(); + renderer = (XSLFImageRenderer) graphics.getRenderingHint(XSLFRenderingHint.IMAGE_RENDERER); + if (renderer == null) renderer = new XSLFImageRenderer(); try { BufferedImage img = renderer.readImage(parentPart.getRelatedPart(rel)); diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java index 3f7d88b870..4018d4d214 100644 --- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java +++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java @@ -77,8 +77,7 @@ public class XSLFConnectorShape extends XSLFSimpleShape { /** - * YK: dashing of lines is suppressed for now. - * @return + * YK: shadows of lines are suppressed for now. */ @Override public XSLFShadow getShadow() { diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java index e61933fb37..cc5fc6c2d5 100644 --- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java +++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java @@ -29,7 +29,7 @@ public interface XSLFFontManager { /** * select a font to be used to paint text * - * @param family the font family as defined in the .pptx file. + * @param typeface the font family as defined in the .pptx file. * This can be unknown or missing in the graphic environment. * * @return the font to be used to paint text diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRendener.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRendener.java deleted file mode 100644 index 06ba185135..0000000000 --- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRendener.java +++ /dev/null @@ -1,108 +0,0 @@ -/* - * ==================================================================== - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ==================================================================== - */ - -package org.apache.poi.xslf.usermodel; - -import org.apache.poi.openxml4j.opc.PackagePart; -import org.apache.poi.util.Beta; - -import javax.imageio.ImageIO; -import java.awt.Graphics2D; -import java.awt.Image; -import java.awt.geom.AffineTransform; -import java.awt.geom.Rectangle2D; -import java.awt.image.BufferedImage; -import java.io.ByteArrayInputStream; -import java.io.IOException; -import java.io.InputStream; - -/** - * For now this class renders only images supported by the javax.imageio.ImageIO - * framework. Subclasses can override this class to support other formats, for - * example, Use Apache batik to render WMF: - * - * 
- * 
- * @Override
- * public class MyImageRendener extends XSLFImageRendener{
- * public boolean drawImage(Graphics2D graphics, XSLFPictureData data, Rectangle2D anchor){
- * 	boolean ok = super.drawImage(graphics, data, anchor);
- * 	if(!ok){
- * 		// see what type of image we are
- * 		String contentType = data.getPackagePart().getContentType();
- * 		if(contentType.equals("image/wmf")){
- * 			// use Apache Batik to handle WMF
- * 			// see http://xmlgraphics.apache.org/batik/
- * 		}
- * 		
- * 	}
- * 	return ok;
- * }
- * }
- * 
- *
- * - * and then pass this class to your instance of java.awt.Graphics2D: - * - * 
- * 
- * graphics.setRenderingHint(XSLFRenderingHint.IMAGE_RENDERER, new MyImageRendener());
- * 
- *
- * - * @author Yegor Kozlov - */ -@Beta -public class XSLFImageRendener { - - /** - * Render picture data into the supplied graphics - * - * @return true if the picture data was succesfully renderered - */ - public boolean drawImage(Graphics2D graphics, XSLFPictureData data, - Rectangle2D anchor) { - try { - BufferedImage img = ImageIO.read(data.getPackagePart().getInputStream()); - double sx = anchor.getWidth()/img.getWidth(); - double sy = anchor.getHeight()/img.getHeight(); - double tx = anchor.getX(); - double ty = anchor.getY(); - AffineTransform at = new AffineTransform(sx, 0, 0, sy, tx, ty) ; - - graphics.drawRenderedImage(img, at); - - return true; - } catch (Exception e) { - return false; - } - - } - - /** - * Create a buffered image from the supplied package part. - * This method is called to create texture paints. - * - * @return a BufferedImage containing the decoded - * contents of the input, or null. - */ - public BufferedImage readImage(PackagePart packagePart) throws IOException { - return ImageIO.read(packagePart.getInputStream()); - } -} \ No newline at end of file diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java new file mode 100644 index 0000000000..f180aba207 --- /dev/null +++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java @@ -0,0 +1,107 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ==================================================================== + */ + +package org.apache.poi.xslf.usermodel; + +import org.apache.poi.openxml4j.opc.PackagePart; +import org.apache.poi.util.Beta; + +import javax.imageio.ImageIO; +import java.awt.Graphics2D; +import java.awt.Image; +import java.awt.geom.AffineTransform; +import java.awt.geom.Rectangle2D; +import java.awt.image.BufferedImage; +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; + +/** + * For now this class renders only images supported by the javax.imageio.ImageIO + * framework. Subclasses can override this class to support other formats, for + * example, Use Apache batik to render WMF: + * + * 
+ * 
+ * public class MyImageRendener extends XSLFImageRendener{
+ * public boolean drawImage(Graphics2D graphics, XSLFPictureData data, Rectangle2D anchor){
+ * 	boolean ok = super.drawImage(graphics, data, anchor);
+ * 	if(!ok){
+ * 		// see what type of image we are
+ * 		String contentType = data.getPackagePart().getContentType();
+ * 		if(contentType.equals("image/wmf")){
+ * 			// use Apache Batik to handle WMF
+ * 			// see http://xmlgraphics.apache.org/batik/
+ * 		}
+ * 		
+ * 	}
+ * 	return ok;
+ * }
+ * }
+ * 
+ *
+ * + * and then pass this class to your instance of java.awt.Graphics2D: + * + * 
+ * 
+ * graphics.setRenderingHint(XSLFRenderingHint.IMAGE_RENDERER, new MyImageRendener());
+ * 
+ *
+ * + * @author Yegor Kozlov + */ +@Beta +public class XSLFImageRenderer { + + /** + * Render picture data into the supplied graphics + * + * @return true if the picture data was successfully rendered + */ + public boolean drawImage(Graphics2D graphics, XSLFPictureData data, + Rectangle2D anchor) { + try { + BufferedImage img = ImageIO.read(data.getPackagePart().getInputStream()); + double sx = anchor.getWidth()/img.getWidth(); + double sy = anchor.getHeight()/img.getHeight(); + double tx = anchor.getX(); + double ty = anchor.getY(); + AffineTransform at = new AffineTransform(sx, 0, 0, sy, tx, ty) ; + + graphics.drawRenderedImage(img, at); + + return true; + } catch (Exception e) { + return false; + } + + } + + /** + * Create a buffered image from the supplied package part. + * This method is called to create texture paints. + * + * @return a BufferedImage containing the decoded + * contents of the input, or null. + */ + public BufferedImage readImage(PackagePart packagePart) throws IOException { + return ImageIO.read(packagePart.getInputStream()); + } +} \ No newline at end of file diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java index 75cc4d15d0..8ad48364ce 100644 --- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java +++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java @@ -22,7 +22,6 @@ package org.apache.poi.xslf.usermodel; import org.apache.poi.POIXMLException; import org.apache.poi.openxml4j.opc.PackagePart; import org.apache.poi.openxml4j.opc.PackageRelationship; -import org.apache.poi.openxml4j.opc.TargetMode; import org.apache.poi.util.Beta; import org.openxmlformats.schemas.drawingml.x2006.main.CTBlip; import org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties; @@ -126,8 +125,8 @@ public class XSLFPictureShape extends XSLFSimpleShape { XSLFPictureData data = getPictureData(); if(data == null) return; - XSLFImageRendener renderer = (XSLFImageRendener)graphics.getRenderingHint(XSLFRenderingHint.IMAGE_RENDERER); - if(renderer == null) renderer = new XSLFImageRendener(); + XSLFImageRenderer renderer = (XSLFImageRenderer)graphics.getRenderingHint(XSLFRenderingHint.IMAGE_RENDERER); + if(renderer == null) renderer = new XSLFImageRenderer(); RenderableShape rShape = new RenderableShape(this); Rectangle2D anchor = rShape.getAnchor(graphics); diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java index 715530c67c..fe68385688 100644 --- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java +++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java @@ -44,7 +44,7 @@ public class XSLFRenderingHint extends RenderingHints.Key { /** * Use a custom image rendener * - * @see XSLFImageRendener + * @see XSLFImageRenderer */ public static final XSLFRenderingHint IMAGE_RENDERER = new XSLFRenderingHint(3); diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java index ec733a1c98..d575e05324 100644 --- a/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java +++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java @@ -65,7 +65,6 @@ public class SheetDataWriter { * Create a writer for the sheet data. * * @param fd the file to write to - * @return */ public Writer createWriter(File fd)throws IOException { return new BufferedWriter(new FileWriter(fd)); diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java index 896be63bd0..0f8d3d70d0 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java @@ -558,12 +558,15 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable * + *

+ * See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} + * for a safe way to create valid names + *

* @param sheetname sheetname to set for the sheet. * @return Sheet representing the new sheet. * @throws IllegalArgumentException if the name is null or invalid * or workbook already contains a sheet with this name - * @see {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} - * for a safe way to create valid names + * @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal) */ public XSSFSheet createSheet(String sheetname) { if (sheetname == null) { @@ -1190,9 +1193,8 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable,IBody { } /** - * @param position in table array + * @param pos in table array * @return The table at position pos * @see org.apache.poi.xwpf.usermodel.IBody#getTableArray(int) */ diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java index 27908901dd..93bc8bfc7b 100644 --- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java +++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java @@ -132,7 +132,7 @@ public class XWPFFootnotes extends POIXMLDocumentPart { /** * add a footnote to the document - * @param footnote + * @param note * @throws IOException */ public XWPFFootnote addFootnote(CTFtnEdn note){ diff --git a/src/scratchpad/src/org/apache/poi/hssf/converter/AbstractExcelUtils.java b/src/scratchpad/src/org/apache/poi/hssf/converter/AbstractExcelUtils.java index 003f755a0e..a45d856145 100644 --- a/src/scratchpad/src/org/apache/poi/hssf/converter/AbstractExcelUtils.java +++ b/src/scratchpad/src/org/apache/poi/hssf/converter/AbstractExcelUtils.java @@ -165,7 +165,7 @@ public class AbstractExcelUtils /** * @param mergedRanges * map of sheet merged ranges built with - * {@link #buildMergedRangesMap(HSSFSheet)} + * {@link ExcelToHtmlUtils#buildMergedRangesMap(HSSFSheet)} * @return {@link CellRangeAddress} from map if cell with specified row and * column numbers contained in found range, null otherwise */ diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/CHPBinTable.java b/src/scratchpad/src/org/apache/poi/hwpf/model/CHPBinTable.java index 3a984d6a8f..2fb452553d 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/CHPBinTable.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/CHPBinTable.java @@ -64,7 +64,7 @@ public class CHPBinTable * Constructor used to read a binTable in from a Word document. * * @deprecated Use - * {@link #CHPBinTable(byte[],byte[],int,int,TextPieceTable)} + * {@link #CHPBinTable(byte[], byte[], int, int, CharIndexTranslator)} * instead */ public CHPBinTable( byte[] documentStream, byte[] tableStream, int offset, diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java b/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java index 28cd870f4b..6b14100710 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java @@ -59,7 +59,7 @@ public final class CHPFormattedDiskPage extends FormattedDiskPage * read from a Word file). * * @deprecated Use - * {@link #CHPFormattedDiskPage(byte[],int,TextPieceTable)} + * {@link #CHPFormattedDiskPage(byte[], int, CharIndexTranslator)} * instead */ @SuppressWarnings( "unused" ) diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java b/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java index 989872d6a8..d09a2db0ef 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java @@ -38,9 +38,9 @@ import org.apache.poi.util.POILogger; * The {@link FibBase} class, holds the * first 32 bytes. * The next part, the fibRgW / FibRgW97, is handled - * by {@link FIBShortHandler}. + * by {@link FibRgW97}. * The next part, the fibRgLw / The FibRgLw97, is - * handled by the {@link FIBLongHandler}. + * handled by the {@link FibRgLw}. * Finally, the rest of the fields are handled by * the {@link FIBFieldHandler}. * diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/PAPBinTable.java b/src/scratchpad/src/org/apache/poi/hwpf/model/PAPBinTable.java index 437ec97439..c277a34df9 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/PAPBinTable.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/PAPBinTable.java @@ -59,7 +59,7 @@ public class PAPBinTable /** * @deprecated Use - * {@link #PAPBinTable(byte[],byte[],byte[],int,int,int,TextPieceTable,boolean)} + * {@link #PAPBinTable(byte[], byte[], byte[], int, int, CharIndexTranslator)} * instead */ @SuppressWarnings( "unused" ) diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java b/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java index 6c78f420b1..f930de3c0f 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java @@ -69,7 +69,7 @@ public final class PAPFormattedDiskPage extends FormattedDiskPage { * Creates a PAPFormattedDiskPage from a 512 byte array * * @deprecated Use - * {@link #PAPFormattedDiskPage(byte[],byte[],int,int,TextPieceTable,boolean)} + * {@link #PAPFormattedDiskPage(byte[], byte[], int, CharIndexTranslator)} * instead */ public PAPFormattedDiskPage( byte[] documentStream, byte[] dataStream, diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/SectionDescriptor.java b/src/scratchpad/src/org/apache/poi/hwpf/model/SectionDescriptor.java index 0fba191f90..0486fa8517 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/SectionDescriptor.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/SectionDescriptor.java @@ -23,7 +23,7 @@ import org.apache.poi.util.LittleEndian; /** * Section Descriptor (SED) * - * @see page 186 for details + * See page 186 for details. */ @Internal public final class SectionDescriptor diff --git a/src/scratchpad/src/org/apache/poi/hwpf/usermodel/Picture.java b/src/scratchpad/src/org/apache/poi/hwpf/usermodel/Picture.java index 413c030952..58ad7aefa1 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/usermodel/Picture.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/usermodel/Picture.java @@ -298,7 +298,7 @@ public final class Picture } /** - * @retrn the vertical aspect ratio for picture provided by user + * @return the vertical aspect ratio for picture provided by user * @deprecated use more precise {@link #getVerticalScalingFactor()} */ @Deprecated