klute 2003/12/04 14:26:01
Modified: src/contrib/src/org/apache/poi/hssf/contrib/view
SVFractionalFormat.java SVTableCellEditor.java
SVTableUtils.java
src/contrib/src/org/apache/poi/hssf/usermodel/contrib
HSSFRegionUtil.java
src/java/org/apache/poi/dev RecordGenerator.java
src/java/org/apache/poi/hssf/eventusermodel
AbortableHSSFListener.java HSSFEventFactory.java
HSSFListener.java
src/java/org/apache/poi/hssf/record BoundSheetRecord.java
src/java/org/apache/poi/hssf/usermodel HSSFFooter.java
HSSFHeader.java HSSFWorkbook.java
src/java/org/apache/poi/hssf/util Region.java package.html
src/java/org/apache/poi/util StringUtil.java
src/scratchpad/src/org/apache/poi/hdf/model/hdftypes
PropertyNode.java
Log:
Removed some of the Javadoc errors. Fellow developers, please run "ant javadocs" and
see what can be improved!
Revision Changes Path
1.4 +1 -1
jakarta-poi/src/contrib/src/org/apache/poi/hssf/contrib/view/SVFractionalFormat.java
Index: SVFractionalFormat.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/contrib/src/org/apache/poi/hssf/contrib/view/SVFractionalFormat.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SVFractionalFormat.java 30 Apr 2003 04:39:14 -0000 1.3
+++ SVFractionalFormat.java 4 Dec 2003 22:26:01 -0000 1.4
@@ -64,7 +64,7 @@
* excel but then again it is a lossy formating mode anyway
*
* @author Jason Height
- * @created 15 July 2002
+ * @since 15 July 2002
*/
public class SVFractionalFormat extends Format {
private short ONE_DIGIT = 1;
1.4 +1 -1
jakarta-poi/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableCellEditor.java
Index: SVTableCellEditor.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableCellEditor.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SVTableCellEditor.java 30 Apr 2003 04:39:14 -0000 1.3
+++ SVTableCellEditor.java 4 Dec 2003 22:26:01 -0000 1.4
@@ -71,7 +71,7 @@
* nearly completely consists of overridden methods.
*
* @author Jason Height
- * @created 16 July 2002
+ * @since 16 July 2002
*/
public class SVTableCellEditor extends AbstractCellEditor implements
TableCellEditor, ActionListener {
private static final Color black = getAWTColor(new HSSFColor.BLACK());
1.3 +1 -1
jakarta-poi/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java
Index: SVTableUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SVTableUtils.java 30 Apr 2003 04:39:14 -0000 1.2
+++ SVTableUtils.java 4 Dec 2003 22:26:01 -0000 1.3
@@ -65,7 +65,7 @@
* SVTableCell Editor and Renderer helper functions.
*
* @author Jason Height
- * @created 16 July 2002
+ * @since 16 July 2002
*/
public class SVTableUtils {
private final static Hashtable colors = HSSFColor.getIndexHash();
1.3 +1 -1
jakarta-poi/src/contrib/src/org/apache/poi/hssf/usermodel/contrib/HSSFRegionUtil.java
Index: HSSFRegionUtil.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/contrib/src/org/apache/poi/hssf/usermodel/contrib/HSSFRegionUtil.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- HSSFRegionUtil.java 30 Apr 2003 04:39:13 -0000 1.2
+++ HSSFRegionUtil.java 4 Dec 2003 22:26:01 -0000 1.3
@@ -71,7 +71,7 @@
* Various utility functions that make working with a region of cells easier.
*
[EMAIL PROTECTED] Eric Pugh [EMAIL PROTECTED]
- [EMAIL PROTECTED] July 29, 2002
+ [EMAIL PROTECTED] July 29, 2002
*/
public class HSSFRegionUtil {
1.6 +1 -1 jakarta-poi/src/java/org/apache/poi/dev/RecordGenerator.java
Index: RecordGenerator.java
===================================================================
RCS file: /home/cvs/jakarta-poi/src/java/org/apache/poi/dev/RecordGenerator.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RecordGenerator.java 30 Apr 2003 04:39:19 -0000 1.5
+++ RecordGenerator.java 4 Dec 2003 22:26:01 -0000 1.6
@@ -65,7 +65,7 @@
* Description of the Class
*
[EMAIL PROTECTED] andy
- [EMAIL PROTECTED] May 10, 2002
+ [EMAIL PROTECTED] May 10, 2002
*/
public class RecordGenerator {
/**
1.3 +2 -2
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.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AbortableHSSFListener.java 30 Apr 2003 04:39:19 -0000 1.2
+++ AbortableHSSFListener.java 4 Dec 2003 22:26:01 -0000 1.3
@@ -63,8 +63,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
* @see org.apache.poi.hssf.HSSFUserException
*
* @author Carey Sublette ([EMAIL PROTECTED])
1.4 +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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- HSSFEventFactory.java 30 Apr 2003 04:39:19 -0000 1.3
+++ HSSFEventFactory.java 4 Dec 2003 22:26:01 -0000 1.4
@@ -164,7 +164,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.3 +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.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- HSSFListener.java 30 Apr 2003 04:39:19 -0000 1.2
+++ HSSFListener.java 4 Dec 2003 22:26:01 -0000 1.3
@@ -62,8 +62,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.11 +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.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- BoundSheetRecord.java 27 Oct 2003 02:01:21 -0000 1.10
+++ BoundSheetRecord.java 4 Dec 2003 22:26:01 -0000 1.11
@@ -194,7 +194,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.6 +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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- HSSFFooter.java 9 Jul 2003 20:21:15 -0000 1.5
+++ HSSFFooter.java 4 Dec 2003 22:26:01 -0000 1.6
@@ -133,7 +133,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;
@@ -150,7 +150,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;
@@ -167,7 +167,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.6 +3 -3
jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java
Index: HSSFHeader.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- HSSFHeader.java 9 Jul 2003 20:21:15 -0000 1.5
+++ HSSFHeader.java 4 Dec 2003 22:26:01 -0000 1.6
@@ -133,7 +133,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;
@@ -150,7 +150,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;
@@ -167,7 +167,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.30 +1 -1
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.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- HSSFWorkbook.java 27 Oct 2003 02:01:21 -0000 1.29
+++ HSSFWorkbook.java 4 Dec 2003 22:26:01 -0000 1.30
@@ -861,7 +861,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.4 +2 -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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Region.java 30 Apr 2003 04:39:08 -0000 1.3
+++ Region.java 4 Dec 2003 22:26:01 -0000 1.4
@@ -190,7 +190,7 @@
/**
* 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 true if the cell is in the range and false if it is not
*/
public boolean contains(int row, short col)
@@ -246,7 +246,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.2 +1 -1 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.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 10 Mar 2002 16:37:37 -0000 1.1
+++ package.html 4 Dec 2003 22:26:01 -0000 1.2
@@ -15,6 +15,6 @@
</ul>
<!-- Put @see and @since tags down here. -->
[EMAIL PROTECTED] org.apache.poi.usermodel
[EMAIL PROTECTED] org.apache.poi.hssf.usermodel
</body>
</html>
1.14 +3 -3 jakarta-poi/src/java/org/apache/poi/util/StringUtil.java
Index: StringUtil.java
===================================================================
RCS file: /home/cvs/jakarta-poi/src/java/org/apache/poi/util/StringUtil.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- StringUtil.java 19 Aug 2003 14:07:40 -0000 1.13
+++ StringUtil.java 4 Dec 2003 22:26:01 -0000 1.14
@@ -65,7 +65,7 @@
[EMAIL PROTECTED] Andrew C. Oliver
[EMAIL PROTECTED] Sergei Kozello (sergeikozello at mail.ru)
[EMAIL PROTECTED] Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot
jp)
- [EMAIL PROTECTED] May 10, 2002
+ [EMAIL PROTECTED] May 10, 2002
[EMAIL PROTECTED] 1.0
*/
public class StringUtil {
@@ -94,7 +94,7 @@
[EMAIL PROTECTED] IllegalArgumentException if len is too large (i.e.,
* there is not enough data in string to create a String of that
* length)
- [EMAIL PROTECTED] the length of the
final string
+ [EMAIL PROTECTED] len the length of the final string
*/
public static String getFromUnicodeLE(
final byte[] string,
@@ -146,7 +146,7 @@
[EMAIL PROTECTED] IllegalArgumentException if len is too large (i.e.,
* there is not enough data in string to create a String of that
* length)
- [EMAIL PROTECTED] the length of the
final string
+ [EMAIL PROTECTED] len the length of the final string
*/
public static String getFromUnicodeBE(
final byte[] string,
1.7 +1 -1
jakarta-poi/src/scratchpad/src/org/apache/poi/hdf/model/hdftypes/PropertyNode.java
Index: PropertyNode.java
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/scratchpad/src/org/apache/poi/hdf/model/hdftypes/PropertyNode.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- PropertyNode.java 27 Jun 2003 00:07:15 -0000 1.6
+++ PropertyNode.java 4 Dec 2003 22:26:01 -0000 1.7
@@ -85,7 +85,7 @@
return _fcStart;
}
/**
- * @retrun The offset of the end of this property's text.
+ * @return The offset of the end of this property's text.
*/
public int getEnd()
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
