fixed javadoc warnings

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1410315 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/ddf/EscherRecord.java b/src/java/org/apache/poi/ddf/EscherRecord.java
index 382333ba3200a90fb2be30463a7661a4b29f4611..2fa56d5b570b66db13de75fe72a2ed77636e1886 100644 (file)
--- a/src/java/org/apache/poi/ddf/EscherRecord.java
+++ b/src/java/org/apache/poi/ddf/EscherRecord.java
@@ -297,7 +297,7 @@ public abstract class EscherRecord {
 
     /**
      * @param tab - each children must be a right of his parent
-     * @return
+     * @return xml representation of this record
      */
     public String toXml(String tab){
         StringBuilder builder = new StringBuilder();

diff --git a/src/java/org/apache/poi/hssf/record/DConRefRecord.java b/src/java/org/apache/poi/hssf/record/DConRefRecord.java
index ed35816353f44126e7ff4982e458c0c570d37a91..629dc00e515cf42685de1314708b846ee90d3639 100644 (file)
--- a/src/java/org/apache/poi/hssf/record/DConRefRecord.java
+++ b/src/java/org/apache/poi/hssf/record/DConRefRecord.java
@@ -278,7 +278,7 @@ public class DConRefRecord extends StandardRecord
 
     /**
      * @return the link's path, with the special characters stripped/replaced. May be null.
-     * @see MS-XLS 2.5.277 (VirtualPath)
+     * See MS-XLS 2.5.277 (VirtualPath)
      */
     public String getReadablePath()
     {

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFClientAnchor.java b/src/java/org/apache/poi/hssf/usermodel/HSSFClientAnchor.java
index ac199e005de445e0e215408da09e3517647f8d2f..75f3b4ece0e92288db18af896502361da9747438 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFClientAnchor.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFClientAnchor.java
@@ -180,7 +180,7 @@ public final class HSSFClientAnchor extends HSSFAnchor implements ClientAnchor {
     }
 
     /**
-     * @return the row(0 based) of the second cell.
+     * @param row2 the row(0 based) of the second cell.
      */
     public void setRow2(int row2) {
         checkRange(row2, 0, 256 * 256, "row2");

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFCombobox.java b/src/java/org/apache/poi/hssf/usermodel/HSSFCombobox.java
index c6cba8f72dbcd7d69a6295f274f26d57ab20e7a4..779455d5cca11522aba4141c4148a73bcfbfcdf8 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFCombobox.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFCombobox.java
@@ -22,7 +22,6 @@ import org.apache.poi.hssf.record.*;
 \r
 /**\r
  * @author Evgeniy Berlog\r
- * @date 12.07.12\r
  */\r
 public class HSSFCombobox extends HSSFSimpleShape {\r
 \r

diff --git a/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java b/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
index e3c812ad5f87f0e9dd7184205153f9461db4b7bf..ea59fa639281da2357ea34074e2d8501ffc64712 100644 (file)
--- a/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
@@ -719,7 +719,7 @@ public final class WorkbookEvaluator {
      * </ul>
      *
      * @param ignore whether to ignore missing references to external workbooks
-     * @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=52575">Bug 52575</a> for details
+     * @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=52575">Bug 52575 for details</a>
      */
     public void setIgnoreMissingWorkbooks(boolean ignore){
         _ignoreMissingWorkbooks = ignore;

diff --git a/src/java/org/apache/poi/ss/usermodel/DateUtil.java b/src/java/org/apache/poi/ss/usermodel/DateUtil.java
index 31942449ffc20dd61bc2ad97724f20589486eb03..12e862d4d1b501532775a37eb52cb6dd610a554f 100644 (file)
--- a/src/java/org/apache/poi/ss/usermodel/DateUtil.java
+++ b/src/java/org/apache/poi/ss/usermodel/DateUtil.java
@@ -256,7 +256,7 @@ public class DateUtil {
 
     /**
      * Get EXCEL date as Java Calendar with given time zone.
-     * @see getJavaDate(double, TimeZone)
+     * @see #getJavaDate(double, TimeZone)
      * @return Java representation of the date, or null if date is not a valid Excel date
      */
     public static Calendar getJavaCalendar(double date, boolean use1904windowing, TimeZone timeZone) {

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFShapeContainer.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFShapeContainer.java
index bcb6afbc7843b11fff520d670e4dbc6974d52075..3a20891846f06979ed0d55bbfcf02fc8c3673a2a 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFShapeContainer.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFShapeContainer.java
@@ -52,9 +52,6 @@ public interface XSLFShapeContainer extends Iterable<XSLFShape> {
 
     /**
      * create a picture belonging to this container
-     *
-     * @param pictureIndex
-     * @return
      */
     XSLFPictureShape createPicture(int pictureIndex);
 

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java
index a932fb5cd389d143fd24dd946a4dd60b39276e83..4f156baa4fcb0b622b426a32608cb20cfedf894e 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java
@@ -302,8 +302,6 @@ public class XSLFTextParagraph implements Iterable<XSLFTextRun>{
      * If bulletSize >= 0, then bulletSize is a percentage of the font size.\r
      * If bulletSize < 0, then it specifies the size in points\r
      * </p>\r
-     *\r
-     * @return the bullet size\r
      */\r
     public void setBulletFontSize(double bulletSize){\r
         CTTextParagraphProperties pr = _p.isSetPPr() ? _p.getPPr() : _p.addNewPPr();\r

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
index 9d61948a9634c2b3850f72052507d36d856a376e..282fca6d11122a4887f238ec972bfb3e46af2edf 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
@@ -655,8 +655,8 @@ public class XWPFRun {
      *  
      * @param pictureData The raw picture data
      * @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
-     * @param image width in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
-     * @param image height in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
+     * @param width width in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
+     * @param height height in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
      * @throws org.apache.poi.openxml4j.exceptions.InvalidFormatException
      * @throws IOException
      */

diff --git a/src/scratchpad/src/org/apache/poi/hslf/model/textproperties/TextPFException9.java b/src/scratchpad/src/org/apache/poi/hslf/model/textproperties/TextPFException9.java
index aa30cb61142664647559cd67bafd561a9ac3c70e..b329c8af3e26d3d7284582a38f1c66c0768777c3 100644 (file)
--- a/src/scratchpad/src/org/apache/poi/hslf/model/textproperties/TextPFException9.java
+++ b/src/scratchpad/src/org/apache/poi/hslf/model/textproperties/TextPFException9.java
@@ -28,7 +28,8 @@ import org.apache.poi.util.LittleEndian;
  * This structure store text autonumber scheme and start number.
  * If a paragraph has an autonumber(fBulletHasAutoNumber = 0x0001) but start number and scheme are empty,
  * this means the default values will be used: statNumber=1 and sheme=ANM_ArabicPeriod
- * @see http://social.msdn.microsoft.com/Forums/mr-IN/os_binaryfile/thread/650888db-fabd-4b95-88dc-f0455f6e2d28
+ * @see <a href="http://social.msdn.microsoft.com/Forums/mr-IN/os_binaryfile/thread/650888db-fabd-4b95-88dc-f0455f6e2d28">
+ *     http://social.msdn.microsoft.com/Forums/mr-IN/os_binaryfile/thread/650888db-fabd-4b95-88dc-f0455f6e2d28</a>
  *
  * @author Alex Nikiforov [mailto:anikif@gmail.com]
  *