klute 2005/01/01 17:00:53
Modified: src/java/org/apache/poi/hssf/dev package.html
src/java/org/apache/poi/hssf/eventusermodel
AbortableHSSFListener.java HSSFEventFactory.java
HSSFListener.java HSSFRequest.java
src/java/org/apache/poi/hssf/model Sheet.java
src/java/org/apache/poi/hssf/record BOFRecord.java
BookBoolRecord.java BoundSheetRecord.java
CodepageRecord.java ExtendedFormatRecord.java
PageBreakRecord.java PaletteRecord.java
src/java/org/apache/poi/hssf/record/formula Area3DPtg.java
AreaPtg.java GreaterThanPtg.java LessThanPtg.java
Ptg.java
src/java/org/apache/poi/hssf/usermodel EscherGraphics.java
HSSFFont.java HSSFFooter.java HSSFName.java
HSSFRow.java HSSFSheet.java HSSFWorkbook.java
package.html
src/java/org/apache/poi/hssf/util Region.java package.html
src/java/org/apache/poi/poifs/common package.html
src/java/org/apache/poi/poifs/dev package.html
src/java/org/apache/poi/poifs/filesystem
POIFSDocumentPath.java
src/java/org/apache/poi/poifs/storage package.html
src/java/org/apache/poi/util package.html
src/scratchpad/src/org/apache/poi/hwpf HWPFDocument.java
src/scratchpad/src/org/apache/poi/hwpf/model
CHPFormattedDiskPage.java FIBLongHandler.java
PAPFormattedDiskPage.java PropertyNode.java
StyleSheet.java
Log:
- Ironed out a whole bunch of Javadoc issues. Not that the documentation is
any better now, but at least Javadoc complains no longer.
Revision Changes Path
1.5 +0 -2 jakarta-poi/src/java/org/apache/poi/hssf/dev/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/dev/package.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- package.html 23 Aug 2004 08:52:26 -0000 1.4
+++ package.html 2 Jan 2005 01:00:51 -0000 1.5
@@ -15,7 +15,5 @@
<li><a href="http://jakarta.apache.org/poi";>Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
[EMAIL PROTECTED] org.apache.poi.hssf
</body>
</html>
1.7 +3 -3
jakarta-poi/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java
Index: AbortableHSSFListener.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- AbortableHSSFListener.java 23 Aug 2004 08:52:27 -0000 1.6
+++ AbortableHSSFListener.java 2 Jan 2005 01:00:51 -0000 1.7
@@ -25,9 +25,9 @@
* a listener supporting this interface and register it with the HSSFRequest
(associating
* it with Record SID's).
*
- * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFRequest
- * @see org.apache.poi.hssf.HSSFUserException
+ * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
+ * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
+ * @see org.apache.poi.hssf.eventusermodel.HSSFUserException
*
* @author Carey Sublette ([EMAIL PROTECTED])
*
1.7 +0 -1
jakarta-poi/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java
Index: HSSFEventFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- HSSFEventFactory.java 23 Aug 2004 08:52:27 -0000 1.6
+++ HSSFEventFactory.java 2 Jan 2005 01:00:51 -0000 1.7
@@ -126,7 +126,6 @@
* @see
org.apache.poi.poifs.filesystem.POIFSFileSystem#createDocumentInputStream(String)
* @param req an Instance of HSSFRequest which has your
registered listeners
* @param in a DocumentInputStream obtained from POIFS's
POIFSFileSystem object
- * @param in a DocumentInputStream obtained from POIFS's
POIFSFileSystem object
* @return numeric user-specified result code.
*/
1.6 +2 -2
jakarta-poi/src/java/org/apache/poi/hssf/eventusermodel/HSSFListener.java
Index: HSSFListener.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/eventusermodel/HSSFListener.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- HSSFListener.java 23 Aug 2004 08:52:27 -0000 1.5
+++ HSSFListener.java 2 Jan 2005 01:00:51 -0000 1.6
@@ -24,8 +24,8 @@
* a listener supporting this interface and register it with the HSSFRequest
(associating
* it with Record SID's).
*
- * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFRequest
+ * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
+ * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
* @author [EMAIL PROTECTED]
*/
1.6 +3 -3
jakarta-poi/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java
Index: HSSFRequest.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- HSSFRequest.java 23 Aug 2004 08:52:27 -0000 1.5
+++ HSSFRequest.java 2 Jan 2005 01:00:51 -0000 1.6
@@ -29,10 +29,10 @@
* An HSSFRequest object should be constructed registering an instance or
multiple
* instances of HSSFListener with each Record.sid you wish to listen for.
*
- * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFListener
+ * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
+ * @see org.apache.poi.hssf.eventusermodel.HSSFListener
* @see org.apache.poi.hssf.dev.EFHSSF
- * @see org.apache.poi.hssf.HSSFUserException
+ * @see org.apache.poi.hssf.eventusermodel.HSSFUserException
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Carey Sublette ([EMAIL PROTECTED])
*/
1.50 +4 -5 jakarta-poi/src/java/org/apache/poi/hssf/model/Sheet.java
Index: Sheet.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/model/Sheet.java,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -r1.49 -r1.50
--- Sheet.java 13 Oct 2004 03:37:56 -0000 1.49
+++ Sheet.java 2 Jan 2005 01:00:52 -0000 1.50
@@ -24,7 +24,6 @@
import org.apache.poi.hssf.record.aggregates.ValueRecordsAggregate;
import org.apache.poi.hssf.record.aggregates.ColumnInfoRecordsAggregate;
import org.apache.poi.hssf.record.formula.Ptg;
-import org.apache.poi.util.IntList;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
@@ -2588,7 +2587,7 @@
/**
* Returns all the row page breaks
- * @return
+ * @return all the row page breaks
*/
public Iterator getRowBreaks() {
return rowBreaks.getBreaksIterator();
@@ -2596,7 +2595,7 @@
/**
* Returns the number of row page breaks
- * @return
+ * @return the number of row page breaks
*/
public int getNumRowBreaks(){
return (int)rowBreaks.getNumBreaks();
@@ -2604,7 +2603,7 @@
/**
* Returns all the column page breaks
- * @return
+ * @return all the column page breaks
*/
public Iterator getColumnBreaks(){
return colBreaks.getBreaksIterator();
@@ -2612,7 +2611,7 @@
/**
* Returns the number of column page breaks
- * @return
+ * @return the number of column page breaks
*/
public int getNumColumnBreaks(){
return (int)colBreaks.getNumBreaks();
1.9 +6 -6
jakarta-poi/src/java/org/apache/poi/hssf/record/BOFRecord.java
Index: BOFRecord.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/BOFRecord.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- BOFRecord.java 23 Aug 2004 08:52:31 -0000 1.8
+++ BOFRecord.java 2 Jan 2005 01:00:52 -0000 1.9
@@ -137,7 +137,7 @@
/**
* Version number - for BIFF8 should be 0x06
* @see #VERSION
- * @param short version to be set
+ * @param version version to be set
*/
public void setVersion(short version)
@@ -153,7 +153,7 @@
* @see #TYPE_CHART
* @see #TYPE_EXCEL_4_MACRO
* @see #TYPE_WORKSPACE_FILE
- * @param short type to be set
+ * @param type type to be set
*/
public void setType(short type)
@@ -164,7 +164,7 @@
/**
* build that wrote this file
* @see #BUILD
- * @param short build number to set
+ * @param build build number to set
*/
public void setBuild(short build)
@@ -175,7 +175,7 @@
/**
* Year of the build that wrote this file
* @see #BUILD_YEAR
- * @param short build year to set
+ * @param year build year to set
*/
public void setBuildYear(short year)
@@ -186,7 +186,7 @@
/**
* set the history bit mask (not very useful)
* @see #HISTORY_MASK
- * @param int bitmask to set for the history
+ * @param bitmask bitmask to set for the history
*/
public void setHistoryBitMask(int bitmask)
@@ -198,7 +198,7 @@
* set the minimum version required to read this file
*
* @see #VERSION
- * @param int version to set
+ * @param version version to set
*/
public void setRequiredVersion(int version)
1.7 +1 -1
jakarta-poi/src/java/org/apache/poi/hssf/record/BookBoolRecord.java
Index: BookBoolRecord.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/BookBoolRecord.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- BookBoolRecord.java 23 Aug 2004 08:52:31 -0000 1.6
+++ BookBoolRecord.java 2 Jan 2005 01:00:52 -0000 1.7
@@ -82,7 +82,7 @@
/**
* set the save ext links flag
*
- * @param short flag (0/1 -off/on)
+ * @param flag flag (0/1 -off/on)
*/
public void setSaveLinkValues(short flag)
1.14 +1 -1
jakarta-poi/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
Index: BoundSheetRecord.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- BoundSheetRecord.java 23 Aug 2004 08:52:31 -0000 1.13
+++ BoundSheetRecord.java 2 Jan 2005 01:00:52 -0000 1.14
@@ -158,7 +158,7 @@
/**
* Set the sheetname for this sheet. (this appears in the tabs at the
bottom)
* @param sheetname the name of the sheet
- * @thows IllegalArgumentException if sheet name will cause excel to
crash.
+ * @throws IllegalArgumentException if sheet name will cause excel to
crash.
*/
public void setSheetname( String sheetname )
1.8 +2 -2
jakarta-poi/src/java/org/apache/poi/hssf/record/CodepageRecord.java
Index: CodepageRecord.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/CodepageRecord.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- CodepageRecord.java 23 Aug 2004 08:52:31 -0000 1.7
+++ CodepageRecord.java 2 Jan 2005 01:00:52 -0000 1.8
@@ -65,7 +65,7 @@
* @param id id must be 0x42 or an exception will be throw upon
validation
* @param size the size of the data area of the record
* @param data data of the record (should not contain sid/len)
- * @param int offset of the record
+ * @param offset offset of the record
*/
public CodepageRecord(short id, short size, byte [] data, int offset)
@@ -90,7 +90,7 @@
* set the codepage for this workbook
*
* @see #CODEPAGE
- * @param codepage - the codepage to set
+ * @param cp the codepage to set
*/
public void setCodepage(short cp)
1.9 +6 -6
jakarta-poi/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java
Index: ExtendedFormatRecord.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ExtendedFormatRecord.java 23 Aug 2004 08:52:31 -0000 1.8
+++ ExtendedFormatRecord.java 2 Jan 2005 01:00:52 -0000 1.9
@@ -601,11 +601,11 @@
}
/**
- * set whether or not to use the pattern in this XF instead of the
parent XF.
- * (foregrount/background)
- *
- * @param pattern- true if this XF has a different pattern value than
its parent,
- * false otherwise.
+ * <p>Sets whether or not to use the pattern in this XF instead of the
+ * parent XF (foreground/background).</p>
+ *
+ * @param pattern <code>true</code> if this XF has a different pattern
+ * value than its parent,</code> false</code> otherwise.
* @see #setIndentionOptions(short)
*/
@@ -620,7 +620,7 @@
* set whether or not to use the locking/hidden in this XF instead of
the parent XF.
*
*
- * @param options- true if this XF has a different locking or hidden
value than its parent,
+ * @param options true if this XF has a different locking or hidden
value than its parent,
* false otherwise.
* @see #setIndentionOptions(short)
*/
1.5 +9 -7
jakarta-poi/src/java/org/apache/poi/hssf/record/PageBreakRecord.java
Index: PageBreakRecord.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/PageBreakRecord.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PageBreakRecord.java 23 Aug 2004 08:52:33 -0000 1.4
+++ PageBreakRecord.java 2 Jan 2005 01:00:52 -0000 1.5
@@ -27,13 +27,15 @@
import org.apache.poi.util.LittleEndian;
/**
- * Record that contains the functionality page breaks (horizontal and
vertical)
- * <p>
- * The other two classes just specifically set the SIDS for record creation
+ * <p>Record that contains the functionality page breaks (horizontal and
vertical)</p>
+ *
+ * <p>The other two classes just specifically set the SIDS for record
creation.</p>
+ *
+ * <p>REFERENCE: Microsoft Excel SDK page 322 and 420</p>
+ *
* @see HorizontalPageBreakRecord
- * @see VerticalPageBreakREcord
+ * @see VerticalPageBreakRecord
*
- * REFERENCE: Microsoft Excel SDK page 322 and 420
* @author Danny Mui (dmui at apache dot org)
*/
public class PageBreakRecord extends Record {
@@ -242,8 +244,8 @@
/**
* Retrieves the region at the row/column indicated
- * @param main
- * @return
+ * @param main FIXME: Document this!
+ * @return FIXME: Document this!
*/
public Break getBreak(short main)
{
1.7 +1 -1
jakarta-poi/src/java/org/apache/poi/hssf/record/PaletteRecord.java
Index: PaletteRecord.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/PaletteRecord.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- PaletteRecord.java 23 Aug 2004 08:52:33 -0000 1.6
+++ PaletteRecord.java 2 Jan 2005 01:00:52 -0000 1.7
@@ -168,7 +168,7 @@
* If the given index is greater than the current last color index,
* then black is inserted at every index required to make the palette
continuous.
*
- * @param i the index to set; if this index is less than 0x8 or greater
than
+ * @param byteIndex the index to set; if this index is less than 0x8 or
greater than
* 0x40, then no modification is made
*/
public void setColor(short byteIndex, byte red, byte green, byte blue)
1.19 +2 -2
jakarta-poi/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java
Index: Area3DPtg.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- Area3DPtg.java 23 Aug 2004 08:52:29 -0000 1.18
+++ Area3DPtg.java 2 Jan 2005 01:00:52 -0000 1.19
@@ -198,7 +198,7 @@
/**
* sets the first row to relative or not
- * @param isRelative or not.
+ * @param rel FIXME: Document this!
*/
public void setFirstRowRelative( boolean rel )
{
@@ -215,7 +215,7 @@
/**
* set whether the last row is relative or not
- * @param last row relative
+ * @param rel FIXME: Document this!
*/
public void setLastRowRelative( boolean rel )
{
1.20 +3 -2
jakarta-poi/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java
Index: AreaPtg.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- AreaPtg.java 23 Aug 2004 08:52:29 -0000 1.19
+++ AreaPtg.java 2 Jan 2005 01:00:52 -0000 1.20
@@ -128,7 +128,7 @@
}
/**
- * @param last row number in the area
+ * @param row last row number in the area
*/
public void setLastRow(short row)
{
@@ -224,7 +224,8 @@
/**
* set whether the last row is relative or not
- * @param last row relative
+ * @param rel <code>true</code> if the last row relative, else
+ * <code>false</code>
*/
public void setLastRowRelative(boolean rel) {
field_4_last_column=rowRelative.setShortBoolean(field_4_last_column,rel);
1.6 +1 -1
jakarta-poi/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java
Index: GreaterThanPtg.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- GreaterThanPtg.java 23 Aug 2004 08:52:29 -0000 1.5
+++ GreaterThanPtg.java 2 Jan 2005 01:00:52 -0000 1.6
@@ -94,7 +94,7 @@
/**
* Implementation of method from Ptg
- * @param refs the Sheet References
+ * @param book the Sheet References
*/
public String toFormulaString(Workbook book)
{
1.6 +1 -1
jakarta-poi/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java
Index: LessThanPtg.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- LessThanPtg.java 23 Aug 2004 08:52:29 -0000 1.5
+++ LessThanPtg.java 2 Jan 2005 01:00:52 -0000 1.6
@@ -103,7 +103,7 @@
/**
* Implementation of method from Ptg
- * @param refs the Sheet References
+ * @param book the Sheet References
*/
public String toFormulaString(Workbook book)
{
1.36 +1 -1
jakarta-poi/src/java/org/apache/poi/hssf/record/formula/Ptg.java
Index: Ptg.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/record/formula/Ptg.java,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- Ptg.java 23 Aug 2004 08:52:29 -0000 1.35
+++ Ptg.java 2 Jan 2005 01:00:52 -0000 1.36
@@ -32,7 +32,7 @@
{
- /** convert infix order ptg list to rpn order ptg list
+ /* convert infix order ptg list to rpn order ptg list
* @return List ptgs in RPN order
* @param infixPtgs List of ptgs in infix order
*/
1.7 +7 -7
jakarta-poi/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
Index: EscherGraphics.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- EscherGraphics.java 23 Aug 2004 08:52:42 -0000 1.6
+++ EscherGraphics.java 2 Jan 2005 01:00:52 -0000 1.7
@@ -109,13 +109,13 @@
this.verticalPixelsPerPoint = 1 / verticalPointsPerPixel;
}
- /**
- * Constructs an escher graphics object.
- *
- * @param escherGroup The escher group to write the graphics
calls into.
- * @param workbook The workbook we are using.
- * @param forecolor The default foreground color.
- */
+// /**
+// * Constructs an escher graphics object.
+// *
+// * @param escherGroup The escher group to write the graphics
calls into.
+// * @param workbook The workbook we are using.
+// * @param forecolor The default foreground color.
+// */
// public EscherGraphics( HSSFShapeGroup escherGroup, HSSFWorkbook
workbook, Color forecolor)
// {
// this(escherGroup, workbook, forecolor, 1.0f);
1.10 +3 -3
jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java
Index: HSSFFont.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- HSSFFont.java 23 Aug 2004 08:52:42 -0000 1.9
+++ HSSFFont.java 2 Jan 2005 01:00:52 -0000 1.10
@@ -162,7 +162,7 @@
/**
* set the font height in unit's of 1/20th of a point. Maybe you might
want to
* use the setFontHeightInPoints which matches to the familiar 10, 12,
14 etc..
- * @param short - height in 1/20ths of a point
+ * @param height height in 1/20ths of a point
* @see #setFontHeightInPoints(short)
*/
@@ -173,7 +173,7 @@
/**
* set the font height
- * @param short - height in the familiar unit of measure - points
+ * @param height height in the familiar unit of measure - points
* @see #setFontHeight(short)
*/
@@ -207,7 +207,7 @@
/**
* set whether to use italics or not
- * @param italics or not
+ * @param italic italics or not
*/
public void setItalic(boolean italic)
1.9 +3 -3
jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java
Index: HSSFFooter.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- HSSFFooter.java 23 Aug 2004 08:52:42 -0000 1.8
+++ HSSFFooter.java 2 Jan 2005 01:00:52 -0000 1.9
@@ -93,7 +93,7 @@
/**
* Sets the left string.
- * @newLeft The string to set as the left side.
+ * @param newLeft The string to set as the left side.
*/
public void setLeft(String newLeft) {
left = newLeft;
@@ -110,7 +110,7 @@
/**
* Sets the center string.
- * @newLeft The string to set as the center.
+ * @param newCenter The string to set as the center.
*/
public void setCenter(String newCenter) {
center = newCenter;
@@ -127,7 +127,7 @@
/**
* Sets the right string.
- * @newLeft The string to set as the right side.
+ * @param newRight The string to set as the right side.
*/
public void setRight(String newRight) {
right = newRight;
1.13 +2 -2
jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFName.java
Index: HSSFName.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFName.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- HSSFName.java 23 Aug 2004 08:52:42 -0000 1.12
+++ HSSFName.java 2 Jan 2005 01:00:52 -0000 1.13
@@ -35,8 +35,8 @@
*
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createName()
* @param name the Name Record
- * @param book - lowlevel Workbook object associated with the sheet.
- * @param book the Workbook */
+ * @param book lowlevel Workbook object associated with the sheet.
+ */
protected HSSFName(Workbook book, NameRecord name) {
this.book = book;
1.19 +2 -2
jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
Index: HSSFRow.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- HSSFRow.java 15 Nov 2004 22:32:00 -0000 1.18
+++ HSSFRow.java 2 Jan 2005 01:00:52 -0000 1.19
@@ -78,7 +78,7 @@
* @param book low-level Workbook object containing the sheet that
contains this row
* @param sheet low-level Sheet object that contains this Row
* @param rowNum the row number of this row (0 based)
- * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(short)
+ * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(int)
*/
//protected HSSFRow(Workbook book, Sheet sheet, short rowNum)
@@ -103,7 +103,7 @@
* @param book low-level Workbook object containing the sheet that
contains this row
* @param sheet low-level Sheet object that contains this Row
* @param record the low level api object this row should represent
- * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(short)
+ * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(int)
*/
protected HSSFRow(Workbook book, Sheet sheet, RowRecord record)
1.30 +7 -7
jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
Index: HSSFSheet.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- HSSFSheet.java 14 Oct 2004 03:38:20 -0000 1.29
+++ HSSFSheet.java 2 Jan 2005 01:00:52 -0000 1.30
@@ -1115,7 +1115,7 @@
/**
* Sets a page break at the indicated row
- * @param row
+ * @param row FIXME: Document this!
*/
public void setRowBreak(int row) {
validateRow(row);
@@ -1124,8 +1124,8 @@
/**
* Determines if there is a page break at the indicated row
- * @param row
- * @return
+ * @param row FIXME: Document this!
+ * @return FIXME: Document this!
*/
public boolean isRowBroken(int row) {
return sheet.isRowBroken(row);
@@ -1141,7 +1141,7 @@
/**
* Retrieves all the horizontal page breaks
- * @return
+ * @return all the horizontal page breaks
*/
public int[] getRowBreaks(){
//we can probably cache this information, but this should be a sparsely
used function
@@ -1157,7 +1157,7 @@
/**
* Retrieves all the vertical page breaks
- * @return
+ * @return all the vertical page breaks
*/
public short[] getColumnBreaks(){
//we can probably cache this information, but this should be a sparsely
used function
@@ -1183,8 +1183,8 @@
/**
* Determines if there is a page break at the indicated column
- * @param column
- * @return
+ * @param column FIXME: Document this!
+ * @return FIXME: Document this!
*/
public boolean isColumnBroken(short column) {
return sheet.isColumnBroken(column);
1.38 +1 -2
jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
Index: HSSFWorkbook.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -r1.37 -r1.38
--- HSSFWorkbook.java 19 Sep 2004 02:06:54 -0000 1.37
+++ HSSFWorkbook.java 2 Jan 2005 01:00:52 -0000 1.38
@@ -242,7 +242,6 @@
* Will throw IllegalArgumentException if the name is greater than 31
chars
* or contains /\?*[]
* @param sheet number (0 based)
- * @param sheet name
*/
public void setSheetName(int sheet, String name)
{
@@ -875,7 +874,7 @@
/**
* For the Convenience of Java Programmers maintaining pointers.
- * @see setPrintArea(int, String)
+ * @see #setPrintArea(int, String)
* @param sheetIndex Zero-based sheet index (0 = First Sheet)
* @param startColumn Column to begin printarea
* @param endColumn Column to end the printarea
1.5 +0 -3
jakarta-poi/src/java/org/apache/poi/hssf/usermodel/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/usermodel/package.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- package.html 23 Aug 2004 08:52:42 -0000 1.4
+++ package.html 2 Jan 2005 01:00:52 -0000 1.5
@@ -14,8 +14,5 @@
<li><a href="http://jakarta.apache.org/poi";>Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
[EMAIL PROTECTED] org.apache.poi.hssf
[EMAIL PROTECTED] org.apache.poi.hssf.eventmodel
</body>
</html>
1.7 +3 -2 jakarta-poi/src/java/org/apache/poi/hssf/util/Region.java
Index: Region.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/util/Region.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Region.java 23 Aug 2004 08:52:44 -0000 1.6
+++ Region.java 2 Jan 2005 01:00:53 -0000 1.7
@@ -152,7 +152,8 @@
/**
* Answers: "is the row/column inside this range?"
*
- * @returns boolean - true if the cell is in the range and false if it
is not
+ * @return <code>true</code> if the cell is in the range and
+ * <code>false</code> if it is not
*/
public boolean contains(int row, short col)
@@ -208,7 +209,7 @@
}
/**
- * @returns the area contained by this region (number of cells)
+ * @return the area contained by this region (number of cells)
*/
public int getArea()
1.5 +0 -2
jakarta-poi/src/java/org/apache/poi/hssf/util/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/util/package.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- package.html 23 Aug 2004 08:52:44 -0000 1.4
+++ package.html 2 Jan 2005 01:00:53 -0000 1.5
@@ -15,7 +15,5 @@
<li><a href="http://jakarta.apache.org/poi";>Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
[EMAIL PROTECTED] org.apache.poi.usermodel
</body>
</html>
1.5 +0 -3
jakarta-poi/src/java/org/apache/poi/poifs/common/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/poifs/common/package.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- package.html 23 Aug 2004 08:52:45 -0000 1.4
+++ package.html 2 Jan 2005 01:00:53 -0000 1.5
@@ -14,8 +14,5 @@
<li><a href="http://jakarta.apache.org/poi";>Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
[EMAIL PROTECTED] org.apache.poi.hssf
[EMAIL PROTECTED] org.apache.poi.hpsf
</body>
</html>
1.5 +0 -2
jakarta-poi/src/java/org/apache/poi/poifs/dev/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/poifs/dev/package.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- package.html 23 Aug 2004 08:52:45 -0000 1.4
+++ package.html 2 Jan 2005 01:00:53 -0000 1.5
@@ -15,7 +15,5 @@
<li><a href="http://jakarta.apache.org/poi";>Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
[EMAIL PROTECTED] org.apache.poi.poifs
</body>
</html>
1.6 +2 -4
jakarta-poi/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java
Index: POIFSDocumentPath.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- POIFSDocumentPath.java 23 Aug 2004 08:52:45 -0000 1.5
+++ POIFSDocumentPath.java 2 Jan 2005 01:00:53 -0000 1.6
@@ -226,7 +226,6 @@
* <p>Returns the path's parent or <code>null</code> if this path
* is the root path.</p>
*
- * @author Rainer Klute ([EMAIL PROTECTED])
* @since 2002-01-24
* @return path of parent, or null if this path is the root path
*/
@@ -250,10 +249,9 @@
* <p>Returns a string representation of the path. Components are
* separated by the platform-specific file separator.</p>
*
- * @author Rainer Klute ([EMAIL PROTECTED])
- * @since 2002-01-24
- *
* @return string representation
+ *
+ * @since 2002-01-24
*/
public String toString()
1.5 +0 -3
jakarta-poi/src/java/org/apache/poi/poifs/storage/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/poifs/storage/package.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- package.html 23 Aug 2004 08:52:45 -0000 1.4
+++ package.html 2 Jan 2005 01:00:53 -0000 1.5
@@ -15,8 +15,5 @@
<li><a href="http://jakarta.apache.org/poi";>Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
[EMAIL PROTECTED] org.apache.poi.poifs
[EMAIL PROTECTED] org.apache.poi.poifs.filesystem
</body>
</html>
1.5 +0 -3 jakarta-poi/src/java/org/apache/poi/util/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-poi/src/java/org/apache/poi/util/package.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- package.html 23 Aug 2004 08:52:45 -0000 1.4
+++ package.html 2 Jan 2005 01:00:53 -0000 1.5
@@ -15,8 +15,5 @@
<li><a href="http://jakarta.apache.org/poi";>Jakarta POI Project</a>
</ul>
-<!-- Put @see and @since tags down here. -->
[EMAIL PROTECTED] org.apache.poi.hssf
[EMAIL PROTECTED] org.apache.poi.hpsf
</body>
</html>
1.14 +1 -1
jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java
Index: HWPFDocument.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- HWPFDocument.java 19 Apr 2004 23:48:01 -0000 1.13
+++ HWPFDocument.java 2 Jan 2005 01:00:53 -0000 1.14
@@ -207,7 +207,7 @@
/**
* Returns the character length of a document.
- * @return
+ * @return the character length of a document
*/
public int characterLength()
{
1.4 +0 -2
jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java
Index: CHPFormattedDiskPage.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CHPFormattedDiskPage.java 19 Apr 2004 23:49:48 -0000 1.3
+++ CHPFormattedDiskPage.java 2 Jan 2005 01:00:53 -0000 1.4
@@ -53,8 +53,6 @@
/**
* This constructs a CHPFormattedDiskPage from a raw fkp (512 byte array
* read from a Word file).
- *
- * @param fkp The 512 byte array to read data from
*/
public CHPFormattedDiskPage(byte[] documentStream, int offset, int fcMin)
{
1.3 +2 -4
jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/FIBLongHandler.java
Index: FIBLongHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/FIBLongHandler.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- FIBLongHandler.java 9 Apr 2004 13:05:32 -0000 1.2
+++ FIBLongHandler.java 2 Jan 2005 01:00:53 -0000 1.3
@@ -21,8 +21,6 @@
import org.apache.poi.util.LittleEndian;
-import org.apache.poi.hwpf.model.io.HWPFOutputStream;
-
public class FIBLongHandler
{
public static final int CBMAC = 0;
@@ -64,8 +62,8 @@
/**
* Refers to a 32 bit windows "long" same as a Java int
- * @param longCode
- * @return
+ * @param longCode FIXME: Document this!
+ * @return FIXME: Document this!
*/
public int getLong(int longCode)
{
1.6 +0 -2
jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java
Index: PAPFormattedDiskPage.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- PAPFormattedDiskPage.java 9 Apr 2004 13:05:32 -0000 1.5
+++ PAPFormattedDiskPage.java 2 Jan 2005 01:00:53 -0000 1.6
@@ -58,8 +58,6 @@
/**
* Creates a PAPFormattedDiskPage from a 512 byte array
- *
- * @param fkp a 512 byte array.
*/
public PAPFormattedDiskPage(byte[] documentStream, byte[] dataStream,
int offset, int fcMin)
{
1.5 +1 -1
jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/PropertyNode.java
Index: PropertyNode.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/PropertyNode.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PropertyNode.java 19 Apr 2004 23:49:48 -0000 1.4
+++ PropertyNode.java 2 Jan 2005 01:00:53 -0000 1.5
@@ -38,7 +38,7 @@
/**
* @param fcStart The start of the text for this property.
* @param fcEnd The end of the text for this property.
- * @param grpprl The property description in compressed form.
+ * @param buf FIXME: Old documentation is: "grpprl The property
description in compressed form."
*/
protected PropertyNode(int fcStart, int fcEnd, Object buf)
{
1.4 +1 -1
jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/StyleSheet.java
Index: StyleSheet.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/model/StyleSheet.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- StyleSheet.java 19 Apr 2004 23:49:48 -0000 1.3
+++ StyleSheet.java 2 Jan 2005 01:00:53 -0000 1.4
@@ -64,7 +64,7 @@
/**
* StyleSheet constructor. Loads a document's stylesheet information,
*
- * @param styleSheet A byte array containing a document's raw stylesheet
+ * @param tableStream A byte array containing a document's raw stylesheet
* info. Found by using FileInformationBlock.getFcStshf() and
* FileInformationBLock.getLcbStshf()
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
