From bb5d321b79193b98051f435621f5044842716c4e Mon Sep 17 00:00:00 2001 From: Andreas Beeker Date: Wed, 14 Apr 2021 22:53:33 +0000 Subject: fix javadocs - remove @author tags (http://apache-poi.1045710.n5.nabble.com/Javadocs-clean-up-remove-author-tags-tp5737663.html) git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1888780 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/poi/examples/hslf/ApacheconEU08.java | 2 -- .../poi/examples/hssf/eventusermodel/XLS2CSVmra.java | 1 - .../poi/examples/hssf/usermodel/Alignment.java | 2 -- .../poi/examples/hssf/usermodel/CreateCells.java | 2 -- .../poi/examples/hssf/usermodel/InCellLists.java | 2 -- .../hssf/usermodel/OfficeDrawingWithGraphics.java | 2 -- .../examples/hssf/usermodel/ReadWriteWorkbook.java | 2 -- .../poi/examples/hssf/usermodel/ZoomSheet.java | 2 -- .../apache/poi/examples/ss/AddDimensionedImage.java | 3 --- .../org/apache/poi/examples/ss/BusinessPlan.java | 2 -- .../org/apache/poi/examples/ss/CalendarDemo.java | 2 -- .../apache/poi/examples/ss/LinkedDropDownLists.java | 1 - .../org/apache/poi/examples/ss/LoanCalculator.java | 2 -- .../org/apache/poi/examples/ss/TimesheetDemo.java | 2 -- .../main/java/org/apache/poi/examples/ss/ToCSV.java | 2 +- .../poi/examples/ss/formula/CalculateMortgage.java | 6 +----- .../org/apache/poi/examples/ss/html/HtmlHelper.java | 2 -- .../java/org/apache/poi/examples/ss/html/ToHtml.java | 2 +- .../apache/poi/examples/ss/html/XSSFHtmlHelper.java | 2 -- .../poi/examples/xssf/usermodel/BigGridDemo.java | 20 ++++++++------------ .../poi/examples/xssf/usermodel/CalendarDemo.java | 2 -- .../poi/examples/xssf/usermodel/CellComments.java | 2 -- .../xwpf/usermodel/SimpleDocumentWithHeader.java | 5 ----- .../poi/examples/xwpf/usermodel/SimpleTable.java | 3 --- .../ruby/java/org/apache/poi/RubyOutputStream.java | 1 - 25 files changed, 11 insertions(+), 63 deletions(-) (limited to 'poi-examples/src') diff --git a/poi-examples/src/main/java/org/apache/poi/examples/hslf/ApacheconEU08.java b/poi-examples/src/main/java/org/apache/poi/examples/hslf/ApacheconEU08.java index 53d3c46077..e71ec75b10 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/hslf/ApacheconEU08.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/hslf/ApacheconEU08.java @@ -45,8 +45,6 @@ import org.apache.poi.sl.usermodel.VerticalAlignment; /** * Presentation for Fast Feather Track on ApacheconEU 2008 - * - * @author Yegor Kozlov */ @SuppressWarnings("java:S1192") public final class ApacheconEU08 { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/hssf/eventusermodel/XLS2CSVmra.java b/poi-examples/src/main/java/org/apache/poi/examples/hssf/eventusermodel/XLS2CSVmra.java index a0b393cf5b..a608499e67 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/hssf/eventusermodel/XLS2CSVmra.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/hssf/eventusermodel/XLS2CSVmra.java @@ -50,7 +50,6 @@ import org.apache.poi.poifs.filesystem.POIFSFileSystem; /** * A XLS -> CSV processor, that uses the MissingRecordAware * EventModel code to ensure it outputs all columns and rows. - * @author Nick Burch */ @SuppressWarnings({"java:S106","java:S4823"}) public class XLS2CSVmra implements HSSFListener { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/Alignment.java b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/Alignment.java index 25affcb0f8..253dbaba97 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/Alignment.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/Alignment.java @@ -31,8 +31,6 @@ import org.apache.poi.ss.usermodel.HorizontalAlignment; /** * Shows how various alignment options work. - * - * @author Glen Stampoultzis (glens at apache.org) */ public class Alignment { public static void main(String[] args) throws IOException { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/CreateCells.java b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/CreateCells.java index 8994d6f17e..c12884f743 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/CreateCells.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/CreateCells.java @@ -27,8 +27,6 @@ import org.apache.poi.hssf.usermodel.HSSFWorkbook; /** * Illustrates how to create cell values. - * - * @author Glen Stampoultzis (glens at apache.org) */ public class CreateCells { public static void main(String[] args) throws IOException { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/InCellLists.java b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/InCellLists.java index 76d0172f82..cfec4222d8 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/InCellLists.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/InCellLists.java @@ -46,8 +46,6 @@ import org.apache.poi.hssf.usermodel.HSSFWorkbook; * are not strictly necessary. If the inputs to the listInCell() and * multilLevelListInCell() methods are constructed to include the bullet * character or the item numbers then these methods alone may be sufficient. - * - * @author Mark Beardsley [msb at apache.org] */ @SuppressWarnings({"java:S106","java:S4823"}) public class InCellLists { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/OfficeDrawingWithGraphics.java b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/OfficeDrawingWithGraphics.java index eca55d4378..61f536f6f7 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/OfficeDrawingWithGraphics.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/OfficeDrawingWithGraphics.java @@ -35,8 +35,6 @@ import org.apache.poi.hssf.usermodel.HSSFWorkbook; /** * Demonstrates the use of the EscherGraphics2d library. - * - * @author Glen Stampoultzis (glens at apache.org) */ public class OfficeDrawingWithGraphics { public static void main( String[] args ) throws IOException { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ReadWriteWorkbook.java b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ReadWriteWorkbook.java index e36b7ad26c..873fde498f 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ReadWriteWorkbook.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ReadWriteWorkbook.java @@ -30,8 +30,6 @@ import org.apache.poi.poifs.filesystem.POIFSFileSystem; /** * This example demonstrates opening a workbook, modifying it and writing * the results back out. - * - * @author Glen Stampoultzis (glens at apache.org) */ public class ReadWriteWorkbook { public static void main(String[] args) throws IOException { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ZoomSheet.java b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ZoomSheet.java index e958489cf7..a3ddcc2f5f 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ZoomSheet.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ZoomSheet.java @@ -27,8 +27,6 @@ import org.apache.poi.hssf.usermodel.HSSFWorkbook; /** * Sets the zoom magnication for a sheet. - * - * @author Glen Stampoultzis (glens at apache.org) */ public class ZoomSheet { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/AddDimensionedImage.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/AddDimensionedImage.java index 6e102038b6..c35e636304 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/AddDimensionedImage.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/AddDimensionedImage.java @@ -180,7 +180,6 @@ import org.apache.poi.util.IOUtils; * grow in size of the column is made wider or the row higher but it will shrink * if the columns width or rows height are reduced. * - * @author Mark Beardsley [msb at apache.org] and Mark Southern [southern at scripps.edu] * @version 1.00 5th August 2009. * 2.00 26th February 2010. * Ported to make use of the the SS usermodel classes. @@ -859,7 +858,6 @@ public class AddDimensionedImage { * either how far the image should be inset from the top or the left hand * edge of the cell. * - * @author Mark Beardsley [msb at apache.org] * @version 1.00 5th August 2009. */ public class ClientAnchorDetail { @@ -928,7 +926,6 @@ public class AddDimensionedImage { * size measurements into pixels and/or millimetres. The class also contains * various constants that are required in other calculations. * - * @author xio[darjino@hotmail.com] * @version 1.01 30th July 2009. * Added by Mark Beardsley [msb at apache.org]. * Additional constants. diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/BusinessPlan.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/BusinessPlan.java index a4865a32a3..e9fe39c173 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/BusinessPlan.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/BusinessPlan.java @@ -44,8 +44,6 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; * A business plan demo * Usage: * BusinessPlan -xls|xlsx - * - * @author Yegor Kozlov */ @SuppressWarnings({"java:S106","java:S4823","java:S1192"}) public final class BusinessPlan { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/CalendarDemo.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/CalendarDemo.java index ead4093ac4..da16f7290a 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/CalendarDemo.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/CalendarDemo.java @@ -45,8 +45,6 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; * Usage: * CalendarDemo -xls|xlsx <year> * - * - * @author Yegor Kozlov */ @SuppressWarnings({"java:S106","java:S4823","java:S1192"}) public final class CalendarDemo { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/LinkedDropDownLists.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/LinkedDropDownLists.java index 5cbc63be60..106b3c14f9 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/LinkedDropDownLists.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/LinkedDropDownLists.java @@ -60,7 +60,6 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; * better to include the name of the sheet when calling the setRefersToFormula() * method. * - * @author Mark Beardsley [msb at apache.org] * @version 1.00 30th March 2012 */ public class LinkedDropDownLists { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/LoanCalculator.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/LoanCalculator.java index 28d1c648f0..26d12f3f12 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/LoanCalculator.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/LoanCalculator.java @@ -42,8 +42,6 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; * * Usage: * LoanCalculator -xls|xlsx - * - * @author Yegor Kozlov */ @SuppressWarnings({"java:S106","java:S4823","java:S1192"}) public final class LoanCalculator { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/TimesheetDemo.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/TimesheetDemo.java index 77b55c826d..59407551b0 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/TimesheetDemo.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/TimesheetDemo.java @@ -41,8 +41,6 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; * A weekly timesheet created using Apache POI. * Usage: * TimesheetDemo -xls|xlsx - * - * @author Yegor Kozlov */ @SuppressWarnings({"java:S106","java:S4823","java:S1192"}) public final class TimesheetDemo { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/ToCSV.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/ToCSV.java index 1c39838cd3..c38709bbfc 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/ToCSV.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/ToCSV.java @@ -118,7 +118,7 @@ import org.apache.poi.ss.usermodel.WorkbookFactory; * class has to be modified to produce files to suit a specific application * or requirement. *

- * @author Mark B + * * @version 1.00 9th April 2010 * 1.10 13th April 2010 - Added support for processing all Excel * workbooks in a folder along with the ability diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/formula/CalculateMortgage.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/formula/CalculateMortgage.java index 2675df181b..fc08d18aa9 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/formula/CalculateMortgage.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/formula/CalculateMortgage.java @@ -26,10 +26,6 @@ import org.apache.poi.ss.formula.functions.FreeRefFunction; /** * A simple user-defined function to calculate principal and interest. - * - * @author Jon Svede ( jon [at] loquatic [dot] com ) - * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov ) - * */ public class CalculateMortgage implements FreeRefFunction { @@ -81,7 +77,7 @@ public class CalculateMortgage implements FreeRefFunction { /** * Excel does not support infinities and NaNs, rather, it gives a #NUM! error in these cases * - * @throws EvaluationException (#NUM!) if result is NaN or Infinity + * @throws EvaluationException (#NUM!) if {@code result} is {@code NaN} or {@code Infinity} */ private void checkValue(double result) throws EvaluationException { if (Double.isNaN(result) || Double.isInfinite(result)) { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/html/HtmlHelper.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/html/HtmlHelper.java index 8747ad4c9d..e8efd40ad7 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/html/HtmlHelper.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/html/HtmlHelper.java @@ -26,8 +26,6 @@ import org.apache.poi.ss.usermodel.CellStyle; * formats. If you are writing such code, you can add a method to this * interface, and then implement it for both HSSF and XSSF workbooks, letting * the driving code stay independent of format. - * - * @author Ken Arnold, Industrious Media LLC */ public interface HtmlHelper { /** diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/html/ToHtml.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/html/ToHtml.java index 65c8878916..5097f34e98 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/html/ToHtml.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/html/ToHtml.java @@ -125,7 +125,7 @@ public final class ToHtml { /** * Creates a new examples to HTML for the given workbook. If the path ends - * with ".xlsx" an {@link XSSFWorkbook} will be used; otherwise + * with "{@code .xlsx}" an {@link XSSFWorkbook} will be used; otherwise * this will use an {@link HSSFWorkbook}. * * @param path The file that has the workbook. diff --git a/poi-examples/src/main/java/org/apache/poi/examples/ss/html/XSSFHtmlHelper.java b/poi-examples/src/main/java/org/apache/poi/examples/ss/html/XSSFHtmlHelper.java index 40bd504818..9784e5dace 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/ss/html/XSSFHtmlHelper.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/ss/html/XSSFHtmlHelper.java @@ -24,8 +24,6 @@ import org.apache.poi.xssf.usermodel.XSSFColor; /** * Implementation of {@link HtmlHelper} for XSSF files. - * - * @author Ken Arnold, Industrious Media LLC */ public class XSSFHtmlHelper implements HtmlHelper { @Override diff --git a/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/BigGridDemo.java b/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/BigGridDemo.java index 574458f7be..c969ad9bea 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/BigGridDemo.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/BigGridDemo.java @@ -49,22 +49,19 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; /** * Demonstrates a workaround you can use to generate large workbooks and avoid OutOfMemory exception. - * + *

* Note - You probably don't want to use this approach any more! POI * now includes the SXSSF which handles all of this for you, you should * be using that instead! This code remains mostly for historical interest. *

- * See - * https://poi.apache.org/spreadsheet/how-to.html#sxssf. - *

* If you really want to use this approach, which is also the one that SXSSF * does for you, it works as follows: + *

    + *
  1. create a template workbook, create sheets and global objects such as cell styles, number formats, etc.
    2. + *
  2. create an application that streams data in a text file
    3. + *
  3. Substitute the sheet in the template with the generated data
    4. + *
* - * 1. create a template workbook, create sheets and global objects such as cell styles, number formats, etc. - * 2. create an application that streams data in a text file - * 3. Substitute the sheet in the template with the generated data - * - *

* Since 3.8 POI provides a low-memory footprint SXSSF API, which implements * ths "BigGridDemo" strategy. SXSSF is an API-compatible streaming extension * of XSSF to be used when very large spreadsheets have to be produced, and @@ -72,9 +69,8 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; * access to the rows that are within a sliding window, while XSSF gives access * to all rows in the document. Older rows that are no longer in the window * become inaccessible, as they are written to the disk. - *

- * See - * https://poi.apache.org/spreadsheet/how-to.html#sxssf. + * + * @see SXSSF (Streaming Usermodel API). */ public final class BigGridDemo { private static final String XML_ENCODING = "UTF-8"; diff --git a/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/CalendarDemo.java b/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/CalendarDemo.java index fa06960bfc..9f0da5e740 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/CalendarDemo.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/CalendarDemo.java @@ -47,8 +47,6 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; * Usage: * CalendarDemo <year> * - * - * @author Yegor Kozlov */ public class CalendarDemo { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/CellComments.java b/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/CellComments.java index eb5757779c..c91bc462af 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/CellComments.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/xssf/usermodel/CellComments.java @@ -39,8 +39,6 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; * Excel comment is a kind of a text shape, * so inserting a comment is very similar to placing a text box in a worksheet *

- * - * @author Yegor Kozlov */ public class CellComments { public static void main(String[] args) throws IOException { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleDocumentWithHeader.java b/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleDocumentWithHeader.java index 659f6b6f39..baed0ce3a2 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleDocumentWithHeader.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleDocumentWithHeader.java @@ -28,11 +28,6 @@ import org.apache.poi.xwpf.usermodel.XWPFRun; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTText; -/** - * - * @author Richard Ngo - * - */ public class SimpleDocumentWithHeader { public static void main(String[] args) throws IOException { diff --git a/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleTable.java b/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleTable.java index 4b9e51e1d1..2f52b627aa 100644 --- a/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleTable.java +++ b/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleTable.java @@ -45,9 +45,6 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.STVerticalJc; * that not all referenced wordprocessingml classes are defined in the * poi-ooxml-lite jar. If this is the case, you'll need to use the * poi-ooxml-full jar library. - * - * @author gisella bronzetti (original) - * @author Gregg Morris (styled table) */ public class SimpleTable { diff --git a/poi-examples/src/main/ruby/java/org/apache/poi/RubyOutputStream.java b/poi-examples/src/main/ruby/java/org/apache/poi/RubyOutputStream.java index e23a0a7d39..0c99f094a8 100644 --- a/poi-examples/src/main/ruby/java/org/apache/poi/RubyOutputStream.java +++ b/poi-examples/src/main/ruby/java/org/apache/poi/RubyOutputStream.java @@ -23,7 +23,6 @@ import java.io.OutputStream; import java.io.IOException; /** - * @author aviks * Wrap a java.io.OutputStream around a Ruby IO object */ -- cgit v1.2.3