Removed some of the Javadoc errors. Fellow developers, please run "ant javadocs" and see what can be improved!

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353464 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Rainer Klute 2003-12-04 22:26:01 +00:00
parent c93c80a275
commit 648f000711
16 changed files with 24 additions and 25 deletions

View File

@ -64,7 +64,7 @@ import java.text.*;
* excel but then again it is a lossy formating mode anyway * excel but then again it is a lossy formating mode anyway
* *
* @author Jason Height * @author Jason Height
* @created 15 July 2002 * @since 15 July 2002
*/ */
public class SVFractionalFormat extends Format { public class SVFractionalFormat extends Format {
private short ONE_DIGIT = 1; private short ONE_DIGIT = 1;

View File

@ -71,7 +71,7 @@ import org.apache.poi.hssf.util.HSSFColor;
* nearly completely consists of overridden methods. * nearly completely consists of overridden methods.
* *
* @author Jason Height * @author Jason Height
* @created 16 July 2002 * @since 16 July 2002
*/ */
public class SVTableCellEditor extends AbstractCellEditor implements TableCellEditor, ActionListener { public class SVTableCellEditor extends AbstractCellEditor implements TableCellEditor, ActionListener {
private static final Color black = getAWTColor(new HSSFColor.BLACK()); private static final Color black = getAWTColor(new HSSFColor.BLACK());

View File

@ -65,7 +65,7 @@ import org.apache.poi.hssf.util.*;
* SVTableCell Editor and Renderer helper functions. * SVTableCell Editor and Renderer helper functions.
* *
* @author Jason Height * @author Jason Height
* @created 16 July 2002 * @since 16 July 2002
*/ */
public class SVTableUtils { public class SVTableUtils {
private final static Hashtable colors = HSSFColor.getIndexHash(); private final static Hashtable colors = HSSFColor.getIndexHash();

View File

@ -71,7 +71,7 @@ import org.apache.commons.lang.exception.NestableException;
* Various utility functions that make working with a region of cells easier. * Various utility functions that make working with a region of cells easier.
* *
*@author Eric Pugh epugh@upstate.com *@author Eric Pugh epugh@upstate.com
*@created July 29, 2002 *@since July 29, 2002
*/ */
public class HSSFRegionUtil { public class HSSFRegionUtil {

View File

@ -65,7 +65,7 @@ import java.io.File;
* Description of the Class * Description of the Class
* *
*@author andy *@author andy
*@created May 10, 2002 *@since May 10, 2002
*/ */
public class RecordGenerator { public class RecordGenerator {
/** /**

View File

@ -63,8 +63,8 @@ import org.apache.poi.hssf.eventusermodel.HSSFUserException;
* a listener supporting this interface and register it with the HSSFRequest (associating * a listener supporting this interface and register it with the HSSFRequest (associating
* it with Record SID's). * it with Record SID's).
* *
* @see org.apache.poi.hssf.eventmodel.HSSFEventFactory * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
* @see org.apache.poi.hssf.eventmodel.HSSFRequest * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
* @see org.apache.poi.hssf.HSSFUserException * @see org.apache.poi.hssf.HSSFUserException
* *
* @author Carey Sublette (careysub@earthling.net) * @author Carey Sublette (careysub@earthling.net)

View File

@ -164,7 +164,6 @@ public class HSSFEventFactory
* @see org.apache.poi.poifs.filesystem.POIFSFileSystem#createDocumentInputStream(String) * @see org.apache.poi.poifs.filesystem.POIFSFileSystem#createDocumentInputStream(String)
* @param req an Instance of HSSFRequest which has your registered listeners * @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
* @param in a DocumentInputStream obtained from POIFS's POIFSFileSystem object
* @return numeric user-specified result code. * @return numeric user-specified result code.
*/ */

View File

@ -62,8 +62,8 @@ import org.apache.poi.hssf.record.Record;
* a listener supporting this interface and register it with the HSSFRequest (associating * a listener supporting this interface and register it with the HSSFRequest (associating
* it with Record SID's). * it with Record SID's).
* *
* @see org.apache.poi.hssf.eventmodel.HSSFEventFactory * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
* @see org.apache.poi.hssf.eventmodel.HSSFRequest * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
* @author acoliver@apache.org * @author acoliver@apache.org
*/ */

View File

@ -194,7 +194,7 @@ public class BoundSheetRecord
/** /**
* Set the sheetname for this sheet. (this appears in the tabs at the bottom) * Set the sheetname for this sheet. (this appears in the tabs at the bottom)
* @param sheetname the name of the sheet * @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 ) public void setSheetname( String sheetname )

View File

@ -133,7 +133,7 @@ public class HSSFFooter extends Object {
/** /**
* Sets the left string. * 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) { public void setLeft(String newLeft) {
left = newLeft; left = newLeft;
@ -150,7 +150,7 @@ public class HSSFFooter extends Object {
/** /**
* Sets the center string. * 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) { public void setCenter(String newCenter) {
center = newCenter; center = newCenter;
@ -167,7 +167,7 @@ public class HSSFFooter extends Object {
/** /**
* Sets the right string. * 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) { public void setRight(String newRight) {
right = newRight; right = newRight;

View File

@ -133,7 +133,7 @@ public class HSSFHeader extends Object {
/** /**
* Sets the left string. * 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) { public void setLeft(String newLeft) {
left = newLeft; left = newLeft;
@ -150,7 +150,7 @@ public class HSSFHeader extends Object {
/** /**
* Sets the center string. * 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) { public void setCenter(String newCenter) {
center = newCenter; center = newCenter;
@ -167,7 +167,7 @@ public class HSSFHeader extends Object {
/** /**
* Sets the right string. * 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) { public void setRight(String newRight) {
right = newRight; right = newRight;

View File

@ -861,7 +861,7 @@ public class HSSFWorkbook
/** /**
* For the Convenience of Java Programmers maintaining pointers. * 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 sheetIndex Zero-based sheet index (0 = First Sheet)
* @param startColumn Column to begin printarea * @param startColumn Column to begin printarea
* @param endColumn Column to end the printarea * @param endColumn Column to end the printarea

View File

@ -190,7 +190,7 @@ public class Region
/** /**
* Answers: "is the row/column inside this range?" * 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) 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() public int getArea()

View File

@ -15,6 +15,6 @@ For overviews, tutorials, examples, guides, and tool documentation, please see:
</ul> </ul>
<!-- Put @see and @since tags down here. --> <!-- Put @see and @since tags down here. -->
@see org.apache.poi.usermodel @see org.apache.poi.hssf.usermodel
</body> </body>
</html> </html>

View File

@ -65,7 +65,7 @@ import java.util.Arrays;
*@author Andrew C. Oliver *@author Andrew C. Oliver
*@author Sergei Kozello (sergeikozello at mail.ru) *@author Sergei Kozello (sergeikozello at mail.ru)
*@author Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp) *@author Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp)
*@created May 10, 2002 *@since May 10, 2002
*@version 1.0 *@version 1.0
*/ */
public class StringUtil { public class StringUtil {
@ -94,7 +94,7 @@ public class StringUtil {
*@exception IllegalArgumentException if len is too large (i.e., *@exception IllegalArgumentException if len is too large (i.e.,
* there is not enough data in string to create a String of that * there is not enough data in string to create a String of that
* length) * length)
*@len the length of the final string *@param len the length of the final string
*/ */
public static String getFromUnicodeLE( public static String getFromUnicodeLE(
final byte[] string, final byte[] string,
@ -146,7 +146,7 @@ public class StringUtil {
*@exception IllegalArgumentException if len is too large (i.e., *@exception IllegalArgumentException if len is too large (i.e.,
* there is not enough data in string to create a String of that * there is not enough data in string to create a String of that
* length) * length)
*@len the length of the final string *@param len the length of the final string
*/ */
public static String getFromUnicodeBE( public static String getFromUnicodeBE(
final byte[] string, final byte[] string,

View File

@ -85,7 +85,7 @@ public class PropertyNode implements Comparable
return _fcStart; 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() public int getEnd()
{ {