]> source.dussan.org Git - poi.git/commitdiff
Removed some of the Javadoc errors. Fellow developers, please run "ant javadocs"...
authorRainer Klute <klute@apache.org>
Thu, 4 Dec 2003 22:26:01 +0000 (22:26 +0000)
committerRainer Klute <klute@apache.org>
Thu, 4 Dec 2003 22:26:01 +0000 (22:26 +0000)
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353464 13f79535-47bb-0310-9956-ffa450edef68

16 files changed:
src/contrib/src/org/apache/poi/hssf/contrib/view/SVFractionalFormat.java
src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableCellEditor.java
src/contrib/src/org/apache/poi/hssf/contrib/view/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
src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java
src/java/org/apache/poi/hssf/eventusermodel/HSSFListener.java
src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java
src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java
src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
src/java/org/apache/poi/hssf/util/Region.java
src/java/org/apache/poi/hssf/util/package.html
src/java/org/apache/poi/util/StringUtil.java
src/scratchpad/src/org/apache/poi/hdf/model/hdftypes/PropertyNode.java

index 47eb588ce0e652262dc0102ea8ff9f05d7347be4..bfdb23c153b88ccd13d432b3193d94475d7dc353 100644 (file)
@@ -64,7 +64,7 @@ import java.text.*;
  * 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;
index 5dbfefa0e4dc81f6f4f78a6524ef6060bcb436d0..f8811ae628919d51ef6b3f0705aae30fb733e910 100644 (file)
@@ -71,7 +71,7 @@ import org.apache.poi.hssf.util.HSSFColor;
  * 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());
index deb6403ab20608ca538d2289d587d190667a7a74..a5259910a40e7a3fb4430890a4ec8affb259d5d3 100644 (file)
@@ -65,7 +65,7 @@ import org.apache.poi.hssf.util.*;
  * 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();
index db9a0ada5450ce022bb0acfa39176826b69013bf..4339a922d0ab527482a57d4e8701a98c6e0ca452 100644 (file)
@@ -71,7 +71,7 @@ import org.apache.commons.lang.exception.NestableException;
  *  Various utility functions that make working with a region of cells easier.
  *
  *@author     Eric Pugh epugh@upstate.com
- *@created    July 29, 2002
+ *@since      July 29, 2002
  */
 
 public class HSSFRegionUtil {
index 8e9ea7ef67b48d6c3d281cedb659a16709be6639..3b1338d19556cabc016114392e47b23440b16dfe 100644 (file)
@@ -65,7 +65,7 @@ import java.io.File;
  *  Description of the Class
  *
  *@author     andy
- *@created    May 10, 2002
+ *@since      May 10, 2002
  */
 public class RecordGenerator {
     /**
index ed80b407f3b9d25bf49269520eecbfaf9c7f8ae8..697df33d381fe8697a489ce1dfef47933f5ddcc8 100644 (file)
@@ -63,8 +63,8 @@ import org.apache.poi.hssf.eventusermodel.HSSFUserException;
  * 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 (careysub@earthling.net)
index 3828a53a2f148242bc3ee39dc47d24146fa5c232..3f8c38a955c664eb6ba63ce06c6ec3cea6a78ee4 100644 (file)
@@ -164,7 +164,6 @@ public class HSSFEventFactory
         * @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.
         */
 
index dbc1f69b755e738bf3eb97f2fa60eb32aade3156..483b67c6780b00b5d43cfaac7b892f6c69a6b6dc 100644 (file)
@@ -62,8 +62,8 @@ import org.apache.poi.hssf.record.Record;
  * 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  acoliver@apache.org
  */
 
index f84b5baa906afd97698183efbaf5e1b9fcd591aa..870d52fdfc3e1752ab6b05e55b0254c31309bdec 100644 (file)
@@ -194,7 +194,7 @@ public class BoundSheetRecord
     /**
      * 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 )
index 855067adf9014ec3f2236b4d24d53f13df2b4357..688a37b21d2558f5a7cf67bdd47eb2d92ae4d498 100644 (file)
@@ -133,7 +133,7 @@ public class HSSFFooter extends Object {
 
   /**
    * 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 @@ public class HSSFFooter extends Object {
 
   /**
    * 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 @@ public class HSSFFooter extends Object {
 
   /**
    * 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;
index 1345cebe8f8ea0b3464d36e761991b3cdc87349c..42c5816f4c7ae585bba81571560011a2aaa15ca5 100644 (file)
@@ -133,7 +133,7 @@ public class HSSFHeader extends Object {
 
   /**
    * 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 @@ public class HSSFHeader extends Object {
 
   /**
    * 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 @@ public class HSSFHeader extends Object {
 
   /**
    * 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;
index 799029b9b16cb33cf653982feebb7afe7f95288c..e3fd336168c0dd85702f975033d540b6213c5b3e 100644 (file)
@@ -861,7 +861,7 @@ public class HSSFWorkbook
        
        /**
         * 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
index 582d9524fe9f80a0d103dd2ccbd81af81f1b7ce4..5afd86b18ced2d2611e546878b9c347ab38bd737 100644 (file)
@@ -190,7 +190,7 @@ public class Region
     /**
      * 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 @@ public class Region
     }
 
     /**
-     * @returns the area contained by this region (number of cells)
+     * @return the area contained by this region (number of cells)
      */
 
     public int getArea()
index 02a94054fb6a4175057d511663777a809645ca9a..c78e5e263e9eab811e315815802b3039c37c097a 100755 (executable)
@@ -15,6 +15,6 @@ For overviews, tutorials, examples, guides, and tool documentation, please see:
 </ul>
 
 <!-- Put @see and @since tags down here. -->
-@see org.apache.poi.usermodel
+@see org.apache.poi.hssf.usermodel
 </body>
 </html>
index 910ee978197cb72925128f417bdae735e4ac1230..c856b0181d84d13806100c0c01db157b3cbe72bf 100644 (file)
@@ -65,7 +65,7 @@ import java.util.Arrays;
  *@author     Andrew C. Oliver 
  *@author     Sergei Kozello (sergeikozello at mail.ru) 
  *@author     Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp) 
- *@created    May 10, 2002 
+ *@since      May 10, 2002 
  *@version    1.0 
  */
 public class StringUtil {
@@ -94,7 +94,7 @@ public class StringUtil {
         *@exception  IllegalArgumentException        if len is too large (i.e.,     
         *      there is not enough data in string to create a String of that     
         *      length)     
-        *@len                                        the length of the final string     
+        *@param len the length of the final string     
         */
        public static String getFromUnicodeLE(
                final byte[] string,
@@ -146,7 +146,7 @@ public class StringUtil {
         *@exception  IllegalArgumentException        if len is too large (i.e.,     
         *      there is not enough data in string to create a String of that     
         *      length)     
-        *@len                                        the length of the final string     
+        *@param len the length of the final string     
         */
        public static String getFromUnicodeBE(
                final byte[] string,
index 12657ccb4699a5efe977c5cd6fb84171a8d388e0..339a059b673b3c5156cc985a39b7f1c54c8468e4 100644 (file)
@@ -85,7 +85,7 @@ public class PropertyNode implements Comparable
       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()
   {