From 695dae4c92afaa92e704eac9edda2229dcd7cbe4 Mon Sep 17 00:00:00 2001 From: Yegor Kozlov Date: Mon, 2 Jul 2007 16:08:26 +0000 Subject: [PATCH] keep the javadoc compiler quiet git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@552525 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java | 4 ++-- .../org/apache/poi/hssf/usermodel/HSSFShapeGroup.java | 1 - src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java | 4 ++-- src/java/org/apache/poi/hssf/util/PaneInformation.java | 8 ++++---- .../src/org/apache/poi/hslf/record/RecordContainer.java | 2 +- .../org/apache/poi/hslf/record/TxMasterStyleAtom.java | 2 +- .../poi/hssf/record/formula/functions/FinanceLib.java | 4 ++-- .../apache/poi/hssf/record/formula/functions/MathX.java | 9 ++++++--- .../hssf/record/formula/functions/XYNumericFunction.java | 3 ++- .../apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java | 3 ++- .../poi/hssf/eventmodel/TestEventRecordFactory.java | 2 +- .../org/apache/poi/hssf/usermodel/TestHSSFDateUtil.java | 1 - 12 files changed, 23 insertions(+), 20 deletions(-) diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java b/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java index 9bda5dd5d1..2da04e7f49 100644 --- 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 05b694739b..19e54e2adc 100644 --- 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 74bda60fbc..59a31213eb 100644 --- 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 c928f5a340..3ca96bab37 100644 --- 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 601ce79b62..2aaab41b94 100644 --- 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 c3025fb4be..05bf42c7b8 100644 --- 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 8baa495489..96f8717a2c 100644 --- 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 ec682d6f19..593998f1e9 100644 --- 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 9f5bcb102f..1e6955ad94 100644 --- 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 1b8074752e..26f931402f 100644 --- 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 c4c169eb3a..0449795b5d 100644 --- 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 ddf20fd774..174e01972a 100644 --- 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%