From 313191f5aa0c4e7a891c80b0d13136f43de9266d Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Fri, 29 Jun 2007 15:01:01 +0000 Subject: [PATCH] Yet more javadoc fixes git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@551914 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/poi/hssf/record/CustomField.java | 5 +---- .../org/apache/poi/hssf/record/ExternSheetRecord.java | 4 +--- .../org/apache/poi/hssf/record/MulBlankRecord.java | 2 -- src/java/org/apache/poi/hssf/record/MulRKRecord.java | 2 -- src/java/org/apache/poi/hssf/record/NameRecord.java | 3 ++- src/java/org/apache/poi/hssf/record/NoteRecord.java | 4 ++-- .../org/apache/poi/hssf/record/PageBreakRecord.java | 7 ------- src/java/org/apache/poi/hssf/record/Record.java | 4 +--- .../org/apache/poi/hssf/record/RecordInputStream.java | 2 +- src/java/org/apache/poi/hssf/record/SSTRecord.java | 8 ++------ src/java/org/apache/poi/hssf/record/StringRecord.java | 2 -- src/java/org/apache/poi/hssf/record/SupBookRecord.java | 2 -- .../org/apache/poi/hssf/record/TopMarginRecord.java | 10 +++++----- src/java/org/apache/poi/hssf/record/UnknownRecord.java | 4 +--- .../hssf/record/aggregates/RowRecordsAggregate.java | 8 +------- .../hssf/record/aggregates/ValueRecordsAggregate.java | 8 +------- .../apache/poi/hssf/record/formula/GreaterThanPtg.java | 3 +-- .../apache/poi/hssf/record/formula/LessThanPtg.java | 3 +-- .../org/apache/poi/hssf/usermodel/HSSFDateUtil.java | 3 ++- src/java/org/apache/poi/hssf/usermodel/HSSFFont.java | 1 - 20 files changed, 22 insertions(+), 63 deletions(-) diff --git a/src/java/org/apache/poi/hssf/record/CustomField.java b/src/java/org/apache/poi/hssf/record/CustomField.java index d28a611a8..474d3b2b4 100644 --- a/src/java/org/apache/poi/hssf/record/CustomField.java +++ b/src/java/org/apache/poi/hssf/record/CustomField.java @@ -28,10 +28,7 @@ public interface CustomField /** * Populates this fields data from the byte array passed in. - * @param data raw data - * @param size size of data - * @param offset of the record's data (provided a big array of the file) - * @return the number of bytes read. + * @param in the RecordInputstream to read the record from */ int fillField(RecordInputStream in); diff --git a/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java b/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java index 95c4442b1..0d1823a7c 100644 --- a/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java @@ -65,9 +65,7 @@ public class ExternSheetRecord extends Record { * called by the constructor, should set class level fields. Should throw * runtime exception for bad/icomplete data. * - * @param data raw data - * @param size size of data - * @param offset of the record's data (provided a big array of the file) + * @param in the RecordInputstream to read the record from */ protected void fillFields(RecordInputStream in) { field_2_REF_structures = new ArrayList(); diff --git a/src/java/org/apache/poi/hssf/record/MulBlankRecord.java b/src/java/org/apache/poi/hssf/record/MulBlankRecord.java index b3ea11747..dffdb2fe8 100644 --- a/src/java/org/apache/poi/hssf/record/MulBlankRecord.java +++ b/src/java/org/apache/poi/hssf/record/MulBlankRecord.java @@ -118,9 +118,7 @@ public class MulBlankRecord /** * @param in the RecordInputstream to read the record from - * @param size size of data */ - protected void fillFields(RecordInputStream in) { //field_1_row = LittleEndian.getShort(data, 0 + offset); diff --git a/src/java/org/apache/poi/hssf/record/MulRKRecord.java b/src/java/org/apache/poi/hssf/record/MulRKRecord.java index 3aed6d00d..397b97951 100644 --- a/src/java/org/apache/poi/hssf/record/MulRKRecord.java +++ b/src/java/org/apache/poi/hssf/record/MulRKRecord.java @@ -121,9 +121,7 @@ public class MulRKRecord /** * @param in the RecordInputstream to read the record from - * @param size size of data */ - protected void fillFields(RecordInputStream in) { //field_1_row = LittleEndian.getShort(data, 0 + offset); diff --git a/src/java/org/apache/poi/hssf/record/NameRecord.java b/src/java/org/apache/poi/hssf/record/NameRecord.java index 97c9747ca..c920a4afc 100644 --- a/src/java/org/apache/poi/hssf/record/NameRecord.java +++ b/src/java/org/apache/poi/hssf/record/NameRecord.java @@ -491,7 +491,8 @@ public class NameRecord extends Record { /** * called by the class that is responsible for writing this sucker. * Subclasses should implement this so that their data is passed back in a - * @param in the RecordInputstream to read the record from + * @param offset to begin writing at + * @param data byte array containing instance data * @return number of bytes written */ public int serialize( int offset, byte[] data ) diff --git a/src/java/org/apache/poi/hssf/record/NoteRecord.java b/src/java/org/apache/poi/hssf/record/NoteRecord.java index 018ae7e76..63c0b1d7d 100644 --- a/src/java/org/apache/poi/hssf/record/NoteRecord.java +++ b/src/java/org/apache/poi/hssf/record/NoteRecord.java @@ -194,8 +194,8 @@ public class NoteRecord extends Record { * Options flags. * * @return the options flag - * @see NoteRecord.NOTE_VISIBLE - * @see NoteRecord.NOTE_HIDDEN + * @see #NOTE_VISIBLE + * @see #NOTE_HIDDEN */ public short getFlags(){ return field_3_flags; diff --git a/src/java/org/apache/poi/hssf/record/PageBreakRecord.java b/src/java/org/apache/poi/hssf/record/PageBreakRecord.java index 1b55d0315..83eade95d 100644 --- a/src/java/org/apache/poi/hssf/record/PageBreakRecord.java +++ b/src/java/org/apache/poi/hssf/record/PageBreakRecord.java @@ -35,14 +35,7 @@ import org.apache.poi.util.LittleEndian; *

REFERENCE: Microsoft Excel SDK page 322 and 420

* * @see HorizontalPageBreakRecord -<<<<<<< PageBreakRecord.java - * @see VerticalPageBreakREcord - * - * REFERENCE: Microsoft Excel SDK page 322 and 420 -======= * @see VerticalPageBreakRecord - * ->>>>>>> 1.5 * @author Danny Mui (dmui at apache dot org) */ public class PageBreakRecord extends Record { diff --git a/src/java/org/apache/poi/hssf/record/Record.java b/src/java/org/apache/poi/hssf/record/Record.java index 133fe8d5c..3205c5774 100644 --- a/src/java/org/apache/poi/hssf/record/Record.java +++ b/src/java/org/apache/poi/hssf/record/Record.java @@ -66,9 +66,7 @@ public abstract class Record * called by the constructor, should set class level fields. Should throw * runtime exception for bad/icomplete data. * - * @param data raw data - * @param size size of data - * @param offset of the record's data (provided a big array of the file) + * @param in the RecordInputstream to read the record from */ protected abstract void fillFields(RecordInputStream in); diff --git a/src/java/org/apache/poi/hssf/record/RecordInputStream.java b/src/java/org/apache/poi/hssf/record/RecordInputStream.java index 01a8df58d..fc861f390 100755 --- a/src/java/org/apache/poi/hssf/record/RecordInputStream.java +++ b/src/java/org/apache/poi/hssf/record/RecordInputStream.java @@ -220,7 +220,7 @@ public class RecordInputStream extends InputStream * * { 0x16, 0x00 } -0x16 * - * @param len the length of the final string + * @param length the length of the final string * @return the converted string * @exception IllegalArgumentException if len is too large (i.e., * there is not enough data in string to create a String of that diff --git a/src/java/org/apache/poi/hssf/record/SSTRecord.java b/src/java/org/apache/poi/hssf/record/SSTRecord.java index fe24a3add..9c67c8dca 100644 --- a/src/java/org/apache/poi/hssf/record/SSTRecord.java +++ b/src/java/org/apache/poi/hssf/record/SSTRecord.java @@ -93,10 +93,7 @@ public class SSTRecord /** * Constructs an SST record and sets its fields appropriately. * - * @param id must be 0xfc or an exception will be throw upon - * validation - * @param size the size of the data area of the record - * @param data of the record (should not contain sid/len) + * @param in the RecordInputstream to read the record from */ public SSTRecord( RecordInputStream in ) @@ -352,8 +349,7 @@ public class SSTRecord * associated data. The UnicodeString class can handle the byte[] * vs short[] nature of the actual string data * - * @param data raw data - * @param size size of the raw data + * @param in the RecordInputstream to read the record from */ protected void fillFields( RecordInputStream in ) diff --git a/src/java/org/apache/poi/hssf/record/StringRecord.java b/src/java/org/apache/poi/hssf/record/StringRecord.java index 61e6975f1..a880d7235 100644 --- a/src/java/org/apache/poi/hssf/record/StringRecord.java +++ b/src/java/org/apache/poi/hssf/record/StringRecord.java @@ -67,8 +67,6 @@ public class StringRecord /** * @param in the RecordInputstream to read the record from - * @param size size of data - * @param offset of the record's data (provided a big array of the file) */ protected void fillFields( RecordInputStream in) { diff --git a/src/java/org/apache/poi/hssf/record/SupBookRecord.java b/src/java/org/apache/poi/hssf/record/SupBookRecord.java index 5d435194e..91a16f079 100644 --- a/src/java/org/apache/poi/hssf/record/SupBookRecord.java +++ b/src/java/org/apache/poi/hssf/record/SupBookRecord.java @@ -62,8 +62,6 @@ public class SupBookRecord extends Record /** * @param in the RecordInputstream to read the record from - * @param size size of data - * @param offset of the record's data (provided a big array of the file) */ protected void fillFields(RecordInputStream in) { diff --git a/src/java/org/apache/poi/hssf/record/TopMarginRecord.java b/src/java/org/apache/poi/hssf/record/TopMarginRecord.java index 295e3e0c7..5c507a211 100644 --- a/src/java/org/apache/poi/hssf/record/TopMarginRecord.java +++ b/src/java/org/apache/poi/hssf/record/TopMarginRecord.java @@ -35,10 +35,7 @@ public class TopMarginRecord extends Record implements Margin /** * Constructs a TopMargin record and sets its fields appropriately. * - * @param id id must be 0x28 or an exception - * will be throw upon validation - * @param size size the size of the data area of the record - * @param data data of the record (should not contain sid/len) + * @param in the RecordInputstream to read the record from */ public TopMarginRecord( RecordInputStream in ) { super( in ); } @@ -56,6 +53,9 @@ public class TopMarginRecord extends Record implements Margin } } + /** + * @param in the RecordInputstream to read the record from + */ protected void fillFields( RecordInputStream in ) { field_1_margin = in.readDouble(); @@ -102,4 +102,4 @@ public class TopMarginRecord extends Record implements Margin rec.field_1_margin = this.field_1_margin; return rec; } -} // END OF CLASS \ No newline at end of file +} // END OF CLASS diff --git a/src/java/org/apache/poi/hssf/record/UnknownRecord.java b/src/java/org/apache/poi/hssf/record/UnknownRecord.java index f6770a613..d3e76a020 100644 --- a/src/java/org/apache/poi/hssf/record/UnknownRecord.java +++ b/src/java/org/apache/poi/hssf/record/UnknownRecord.java @@ -136,9 +136,7 @@ public class UnknownRecord * called by the constructor, should set class level fields. Should throw * runtime exception for bad/icomplete data. * - * @param data raw data - * @param size size of data - * @param offset of the records data (provided a big array of the file) + * @param in the RecordInputstream to read the record from */ protected void fillFields(RecordInputStream in) diff --git a/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java index abef0159c..44d37de36 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java @@ -230,14 +230,8 @@ public class RowRecordsAggregate } /** - * called by the constructor, should set class level fields. Should throw - * runtime exception for bad/incomplete data. - * - * @param data raw data - * @param size size of data - * @param offset of the record's data (provided a big array of the file) + * You never fill an aggregate */ - protected void fillFields(RecordInputStream in) { } diff --git a/src/java/org/apache/poi/hssf/record/aggregates/ValueRecordsAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/ValueRecordsAggregate.java index 80b932c51..fe3af5aed 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/ValueRecordsAggregate.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/ValueRecordsAggregate.java @@ -242,14 +242,8 @@ public class ValueRecordsAggregate /** - * called by the constructor, should set class level fields. Should throw - * runtime exception for bad/icomplete data. - * - * @param data raw data - * @param size size of data - * @param offset of the record's data (provided a big array of the file) + * You never fill an aggregate */ - protected void fillFields(RecordInputStream in) { } diff --git a/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java b/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java index 052f7d9bb..6d66307b3 100644 --- a/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java @@ -49,8 +49,7 @@ public class GreaterThanPtg /** * Constructor. Create a new GreaterThanPtg. - * @param data the byte array to have the PTG added to - * @param offset the offset to the PTG to. + * @param in the RecordInputstream to read the record from */ public GreaterThanPtg(RecordInputStream in) { diff --git a/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java b/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java index 07baf3600..4bccd9274 100644 --- a/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java @@ -58,8 +58,7 @@ public class LessThanPtg /** * Constructor. Create a new LessThanPtg. - * @param data the byte array to have the PTG added to - * @param offset the offset to the PTG to. + * @param in the RecordInputstream to read the record from */ public LessThanPtg(RecordInputStream in) { diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java b/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java index 00ca868fe..9bda5dd5d 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFDateUtil.java @@ -160,6 +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) */ public static boolean isADateFormat(int formatIndex, String formatString) { // First up, is this an internal date format? @@ -187,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 #isDateFormat(int,String) */ public static boolean isInternalDateFormat(int format) { boolean retval =false; diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java index 9d2f79678..852e15ee2 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java @@ -383,7 +383,6 @@ public class HSSFFont /** * set character-set to use. - * @return character-set * @see #ANSI_CHARSET * @see #DEFAULT_CHARSET * @see #SYMBOL_CHARSET