You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ye...@apache.org on 2011/12/09 17:48:39 UTC
svn commit: r1212511 - in /poi/trunk/src: java/org/apache/poi/
java/org/apache/poi/hssf/usermodel/ java/org/apache/poi/poifs/filesystem/
java/org/apache/poi/ss/usermodel/ java/org/apache/poi/util/
ooxml/java/org/apache/poi/xslf/usermodel/ ooxml/java/or...
Author: yegor
Date: Fri Dec 9 16:48:38 2011
New Revision: 1212511
URL: http://svn.apache.org/viewvc?rev=1212511&view=rev
Log:
fixed javadoc warnings
Added:
poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java
Removed:
poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRendener.java
Modified:
poi/trunk/src/java/org/apache/poi/POIDocument.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
poi/trunk/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java
poi/trunk/src/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java
poi/trunk/src/java/org/apache/poi/poifs/filesystem/Ole10Native.java
poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormatting.java
poi/trunk/src/java/org/apache/poi/ss/usermodel/SheetConditionalFormatting.java
poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java
poi/trunk/src/java/org/apache/poi/util/LittleEndian.java
poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java
poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java
poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java
poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java
poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/charts/XSSFManualLayout.java
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnote.java
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java
poi/trunk/src/scratchpad/src/org/apache/poi/hssf/converter/AbstractExcelUtils.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPBinTable.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPBinTable.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/SectionDescriptor.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/usermodel/Picture.java
Modified: poi/trunk/src/java/org/apache/poi/POIDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/POIDocument.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/POIDocument.java (original)
+++ poi/trunk/src/java/org/apache/poi/POIDocument.java Fri Dec 9 16:48:38 2011
@@ -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
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java Fri Dec 9 16:48:38 2011
@@ -547,9 +547,8 @@ public final class HSSFWorkbook extends
* @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
* @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)
{
Modified: poi/trunk/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java (original)
+++ poi/trunk/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java Fri Dec 9 16:48:38 2011
@@ -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
Modified: poi/trunk/src/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java (original)
+++ poi/trunk/src/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java Fri Dec 9 16:48:38 2011
@@ -57,7 +57,7 @@ public class FilteringDirectoryNode impl
* 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<String> excludes) {
Modified: poi/trunk/src/java/org/apache/poi/poifs/filesystem/Ole10Native.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/poifs/filesystem/Ole10Native.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/poifs/filesystem/Ole10Native.java (original)
+++ poi/trunk/src/java/org/apache/poi/poifs/filesystem/Ole10Native.java Fri Dec 9 16:48:38 2011
@@ -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
Modified: poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormatting.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormatting.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormatting.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormatting.java Fri Dec 9 16:48:38 2011
@@ -44,7 +44,8 @@ import org.apache.poi.ss.util.CellRangeA
* </LI>
* </UL>
*
- * 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.
* <P>
* To create a new Conditional Formatting set use the following approach:
*
Modified: poi/trunk/src/java/org/apache/poi/ss/usermodel/SheetConditionalFormatting.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/SheetConditionalFormatting.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/usermodel/SheetConditionalFormatting.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/usermodel/SheetConditionalFormatting.java Fri Dec 9 16:48:38 2011
@@ -46,7 +46,7 @@ public interface SheetConditionalFormatt
*
* @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
*/
Modified: poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/usermodel/Workbook.java Fri Dec 9 16:48:38 2011
@@ -129,13 +129,15 @@ public interface Workbook {
/**
* Set the sheet name.
- *
+ * <p>
+ * See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
+ * for a safe way to create valid names
+ * </p>
* @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.
* </p>
*
+ * <p>
+ * See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
+ * for a safe way to create valid names
+ * </p>
* @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);
Modified: poi/trunk/src/java/org/apache/poi/util/LittleEndian.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/util/LittleEndian.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/util/LittleEndian.java (original)
+++ poi/trunk/src/java/org/apache/poi/util/LittleEndian.java Fri Dec 9 16:48:38 2011
@@ -573,7 +573,7 @@ public class LittleEndian implements Lit
*
* @param data
* the byte array
- * @param offset
+ * @param startOffset
* a starting offset into the byte array
* @param value
* the short (16-bit) values
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java Fri Dec 9 16:48:38 2011
@@ -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));
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java Fri Dec 9 16:48:38 2011
@@ -77,8 +77,7 @@ public class XSLFConnectorShape extends
/**
- * YK: dashing of lines is suppressed for now.
- * @return
+ * YK: shadows of lines are suppressed for now.
*/
@Override
public XSLFShadow getShadow() {
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java Fri Dec 9 16:48:38 2011
@@ -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
Added: poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java?rev=1212511&view=auto
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java (added)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java Fri Dec 9 16:48:38 2011
@@ -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:
+ *
+ * <pre>
+ * <code>
+ * 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;
+ * }
+ * }
+ * </code>
+ * </pre>
+ *
+ * and then pass this class to your instance of java.awt.Graphics2D:
+ *
+ * <pre>
+ * <code>
+ * graphics.setRenderingHint(XSLFRenderingHint.IMAGE_RENDERER, new MyImageRendener());
+ * </code>
+ * </pre>
+ *
+ * @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 <code>BufferedImage</code> containing the decoded
+ * contents of the input, or <code>null</code>.
+ */
+ public BufferedImage readImage(PackagePart packagePart) throws IOException {
+ return ImageIO.read(packagePart.getInputStream());
+ }
+}
\ No newline at end of file
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java Fri Dec 9 16:48:38 2011
@@ -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 XS
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);
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java Fri Dec 9 16:48:38 2011
@@ -44,7 +44,7 @@ public class XSLFRenderingHint extends R
/**
* Use a custom image rendener
*
- * @see XSLFImageRendener
+ * @see XSLFImageRenderer
*/
public static final XSLFRenderingHint IMAGE_RENDERER = new XSLFRenderingHint(3);
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java Fri Dec 9 16:48:38 2011
@@ -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));
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java Fri Dec 9 16:48:38 2011
@@ -558,12 +558,15 @@ public class XSSFWorkbook extends POIXML
* The string MUST NOT begin or end with the single quote (') character.
* </p>
*
+ * <p>
+ * See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
+ * for a safe way to create valid names
+ * </p>
* @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 POIXML
* @param sheetname the new sheet name
* @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 sheetIndex, String sheetname) {
validateSheetIndex(sheetIndex);
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/charts/XSSFManualLayout.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/charts/XSSFManualLayout.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/charts/XSSFManualLayout.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/charts/XSSFManualLayout.java Fri Dec 9 16:48:38 2011
@@ -49,7 +49,7 @@ public final class XSSFManualLayout impl
/**
* Create a new SpreadsheetML manual layout.
- * @param layout a Spreadsheet ML layout that should be used as base.
+ * @param ctLayout a Spreadsheet ML layout that should be used as base.
*/
public XSSFManualLayout(CTLayout ctLayout) {
initLayout(ctLayout);
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java Fri Dec 9 16:48:38 2011
@@ -505,9 +505,10 @@ public class XWPFDocument extends POIXML
/**
* 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.
+ * {@link org.apache.xmlbeans.XmlCursor.TokenType#START} tag of an subelement
+ * of the documents body. When this method is done, the cursor passed as
+ * parameter points to the {@link org.apache.xmlbeans.XmlCursor.TokenType#END}
+ * of the newly inserted paragraph.
*
* @param cursor
* @return the {@link XWPFParagraph} object representing the newly inserted
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnote.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnote.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnote.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnote.java Fri Dec 9 16:48:38 2011
@@ -81,7 +81,7 @@ public class XWPFFootnote implements Ite
}
/**
- * @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)
*/
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java Fri Dec 9 16:48:38 2011
@@ -132,7 +132,7 @@ public class XWPFFootnotes extends POIXM
/**
* add a footnote to the document
- * @param footnote
+ * @param note
* @throws IOException
*/
public XWPFFootnote addFootnote(CTFtnEdn note){
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hssf/converter/AbstractExcelUtils.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/converter/AbstractExcelUtils.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hssf/converter/AbstractExcelUtils.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hssf/converter/AbstractExcelUtils.java Fri Dec 9 16:48:38 2011
@@ -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, <tt>null</tt> otherwise
*/
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPBinTable.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPBinTable.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPBinTable.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPBinTable.java Fri Dec 9 16:48:38 2011
@@ -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,
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java Fri Dec 9 16:48:38 2011
@@ -59,7 +59,7 @@ public final class CHPFormattedDiskPage
* read from a Word file).
*
* @deprecated Use
- * {@link #CHPFormattedDiskPage(byte[],int,TextPieceTable)}
+ * {@link #CHPFormattedDiskPage(byte[], int, CharIndexTranslator)}
* instead
*/
@SuppressWarnings( "unused" )
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java Fri Dec 9 16:48:38 2011
@@ -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}.
*
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPBinTable.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPBinTable.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPBinTable.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPBinTable.java Fri Dec 9 16:48:38 2011
@@ -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" )
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java Fri Dec 9 16:48:38 2011
@@ -69,7 +69,7 @@ public final class PAPFormattedDiskPage
* 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,
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/SectionDescriptor.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/SectionDescriptor.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/SectionDescriptor.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/SectionDescriptor.java Fri Dec 9 16:48:38 2011
@@ -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
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/usermodel/Picture.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/usermodel/Picture.java?rev=1212511&r1=1212510&r2=1212511&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/usermodel/Picture.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/usermodel/Picture.java Fri Dec 9 16:48:38 2011
@@ -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
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org