keep the javadoc compiler quiet

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

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java b/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java
index 9bda5dd5d1e6777518fb74ae63a1069bc6255d90..2da04e7f49c21e729b370c1501d1dfe8759cfd33 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java
@@ -160,7 +160,7 @@ public class HSSFDateUtil
      *  
      * @param formatIndex The index of the format, eg from ExtendedFormatRecord.getFormatIndex
      * @param formatString The format string
-     * @see #isInternalDateFormat(int,String) 
+     * @see #isInternalDateFormat(int)
      */
     public static boolean isADateFormat(int formatIndex, String formatString) {
        // First up, is this an internal date format?
@@ -188,7 +188,7 @@ public class HSSFDateUtil
     /**
      * Given a format ID this will check whether the format represents
      *  an internal excel date format or not.
-     * @see #isDateFormat(int,String) 
+     * @see #isADateFormat(int, java.lang.String)  
      */
     public static boolean isInternalDateFormat(int format) {
       boolean retval =false;

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFShapeGroup.java b/src/java/org/apache/poi/hssf/usermodel/HSSFShapeGroup.java
index 05b694739b9d72f40ff3945cf66400c7941f5276..19e54e2adca4a6a1ae3674919b0b0dac9673ca79 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFShapeGroup.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFShapeGroup.java
@@ -103,7 +103,6 @@ public class HSSFShapeGroup
      * @param anchor    the client anchor describes how this group is attached
      *                  to the sheet.
      * @return  the newly created shape.
-     * @author  zunker
      */
     public HSSFPicture createPicture(HSSFChildAnchor anchor, int pictureIndex)
     {

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
index 74bda60fbc45fbc45cbf4cb6a163444ab501f000..59a31213eb803c4cdadf1416206689230749981e 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
@@ -352,7 +352,7 @@ public class HSSFSheet
     /**
      * Get the visibility state for a given column.
      * @param column - the column to get (0-based)
-     * @param width - the visiblity state of the column
+     * @param hidden - the visiblity state of the column
      */
 
     public void setColumnHidden(short column, boolean hidden)
@@ -1414,8 +1414,8 @@ public class HSSFSheet
     /**
      * Sets the default column style for a given column.  POI will only apply this style to new cells added to the sheet.
      *
-     * @param fromCol the starting column index
      * @param column the column index
+     * @param style the style to set
      */
     public void setDefaultColumnStyle(short column, HSSFCellStyle style) {
        sheet.setColumn(column, new Short(style.getIndex()), null, null, null, null);

diff --git a/src/java/org/apache/poi/hssf/util/PaneInformation.java b/src/java/org/apache/poi/hssf/util/PaneInformation.java
index c928f5a34063bbf2559be069cfea2583c6f91e06..3ca96bab37936e26711e0112bcd5c9974cc83e50 100644 (file)
--- a/src/java/org/apache/poi/hssf/util/PaneInformation.java
+++ b/src/java/org/apache/poi/hssf/util/PaneInformation.java
@@ -87,10 +87,10 @@ public class PaneInformation
        
        /**
         * Returns the active pane
-        * @see PANE_LOWER_RIGHT
-        * @see PANE_UPPER_RIGHT
-        * @see PANE_LOWER_LEFT
-        * @see PANE_UPPER_LEFT
+        * @see #PANE_LOWER_RIGHT
+        * @see #PANE_UPPER_RIGHT
+        * @see #PANE_LOWER_LEFT
+        * @see #PANE_UPPER_LEFT
         * @return the active pane.
         */
        public byte getActivePane() {

diff --git a/src/scratchpad/src/org/apache/poi/hslf/record/RecordContainer.java b/src/scratchpad/src/org/apache/poi/hslf/record/RecordContainer.java
index 601ce79b62d04088b63a2f080994a5f2b0d20017..2aaab41b942089006e9236511da066f65b3382e2 100644 (file)
--- a/src/scratchpad/src/org/apache/poi/hslf/record/RecordContainer.java
+++ b/src/scratchpad/src/org/apache/poi/hslf/record/RecordContainer.java
@@ -158,7 +158,7 @@ public abstract class RecordContainer extends Record
        /**
         * Adds the given Child Record before the supplied record
         * @param newChild
-        * @param after
+        * @param before
         */
        public void addChildBefore(Record newChild, Record before) {
                synchronized(changingChildRecordsLock) {

diff --git a/src/scratchpad/src/org/apache/poi/hslf/record/TxMasterStyleAtom.java b/src/scratchpad/src/org/apache/poi/hslf/record/TxMasterStyleAtom.java
index c3025fb4be581ed972ed1a9b61811710184cbc99..05bf42c7b8b0172deae2c0a29569821cf71d889a 100644 (file)
--- a/src/scratchpad/src/org/apache/poi/hslf/record/TxMasterStyleAtom.java
+++ b/src/scratchpad/src/org/apache/poi/hslf/record/TxMasterStyleAtom.java
@@ -74,7 +74,7 @@ public class TxMasterStyleAtom extends RecordAtom {
      * We are of type 4003
      *
      * @return type of this record
-     * @see RecordTypes.TxMasterStyleAtom
+     * @see RecordTypes#TxMasterStyleAtom
      */
     public long getRecordType() {
         return _type;

diff --git a/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/FinanceLib.java b/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/FinanceLib.java
index 8baa49548981aa74e89d4ac46ba5f9adb9513170..96f8717a2c3b5ab10cf0ef2b1c23228b04cd3cc1 100644 (file)
--- a/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/FinanceLib.java
+++ b/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/FinanceLib.java
@@ -75,7 +75,7 @@ public final class FinanceLib {
      * @param r rate
      * @param n num of periods
      * @param y pmt per period
-     * @param f future value
+     * @param p future value
      * @param t type (true=pmt at end of period, false=pmt at begining of period)
      */
     public static double fv(double r, double n, double y, double p, boolean t) {
@@ -162,7 +162,7 @@ public final class FinanceLib {
     /**
      * 
      * @param r
-     * @param n
+     * @param y
      * @param p
      * @param f
      * @param t

diff --git a/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/MathX.java b/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/MathX.java
index ec682d6f19bc439dd6f6f9644a98be4c77013b61..593998f1e9da19d62a7d3eb25e90f0725cdfcec9 100644 (file)
--- a/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/MathX.java
+++ b/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/MathX.java
@@ -463,7 +463,8 @@ public final class MathX {
      * to ensure that the two subarrays are of equal length. If the 
      * subarrays are not of equal length, the return value can be 
      * unpredictable.
-     * @param arrays
+     * @param xarr
+     * @param yarr
      */
     public static double sumx2my2(double[] xarr, double[] yarr) {
         double d = 0;
@@ -488,7 +489,8 @@ public final class MathX {
      * to ensure that the two subarrays are of equal length. If the 
      * subarrays are not of equal length, the return value can be 
      * unpredictable.
-     * @param arrays
+     * @param xarr
+     * @param yarr
      */
     public static double sumx2py2(double[] xarr, double[] yarr) {
         double d = 0;
@@ -514,7 +516,8 @@ public final class MathX {
      * to ensure that the two subarrays are of equal length. If the 
      * subarrays are not of equal length, the return value can be 
      * unpredictable.
-     * @param arrays
+     * @param xarr
+     * @param yarr
      */
     public static double sumxmy2(double[] xarr, double[] yarr) {
         double d = 0;

diff --git a/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/XYNumericFunction.java b/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/XYNumericFunction.java
index 9f5bcb102f6961fdbe13e1b24dad88fc70a53c80..1e6955ad9452fc996b2956ccda3bcfee49998003 100644 (file)
--- a/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/XYNumericFunction.java
+++ b/src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/XYNumericFunction.java
@@ -71,7 +71,8 @@ public abstract class XYNumericFunction extends NumericFunction {
      * that are considered invalid and would result in #VALUE! error in 
      * excel cause this function to return null.
      * 
-     * @param operands
+     * @param xops
+     * @param yops
      * @param srcRow
      * @param srcCol
      */

diff --git a/src/scratchpad/src/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java b/src/scratchpad/src/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
index 1b8074752edd8e805756ff84a2201679cca92aae..26f931402fdb00dad80de154cbc4637a6d666a12 100644 (file)
--- a/src/scratchpad/src/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
+++ b/src/scratchpad/src/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
@@ -282,7 +282,8 @@ public class HSSFFormulaEvaluator {
      * else a runtime exception will be thrown somewhere inside the method.
      * (Hence this is a private method.)
      * 
-     * @param formula
+     * @param srcCell
+     * @param srcRow
      * @param sheet
      * @param workbook
      */

diff --git a/src/testcases/org/apache/poi/hssf/eventmodel/TestEventRecordFactory.java b/src/testcases/org/apache/poi/hssf/eventmodel/TestEventRecordFactory.java
index c4c169eb3a5862792ffb878e1e4a67fdaef08b4f..0449795b5d4ecb490a626556d8da7bb24732bcea 100644 (file)
--- a/src/testcases/org/apache/poi/hssf/eventmodel/TestEventRecordFactory.java
+++ b/src/testcases/org/apache/poi/hssf/eventmodel/TestEventRecordFactory.java
@@ -186,7 +186,7 @@ public class TestEventRecordFactory extends TestCase
     /**
      * tests that the create record function returns a properly 
      * constructed record in the case of a continued record.
-     * @todo - need a real world example to put in a unit test
+     * TODO - need a real world example to put in a unit test
      */
     public void testCreateContinuedRecord()
     {

diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFDateUtil.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFDateUtil.java
index ddf20fd774aa6c98bcf2742c62702e202cd36379..174e01972a83e6c66df4be1fad68998afe747e05 100644 (file)
--- a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFDateUtil.java
+++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFDateUtil.java
@@ -30,7 +30,6 @@ import java.util.TimeZone;
  * Class TestHSSFDateUtil
  *
  *
- * @author
  * @author  Dan Sherman (dsherman at isisph.com)
  * @author  Hack Kampbjorn (hak at 2mba.dk)
  * @version %I%, %G%