Adjust some JavaDoc

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1888419 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Dominik Stadler 2021-04-06 06:11:07 +00:00
parent 3aa712c32b
commit c0cf4ebc6b
7 changed files with 15 additions and 11 deletions

View File

@ -63,7 +63,7 @@ import org.apache.poi.poifs.filesystem.POIFSFileSystem;
* *
* <li><p>Write the POI filesystem back to the original file.</p></li> * <li><p>Write the POI filesystem back to the original file.</p></li>
* *
* </ol> * </ul>
*/ */
@SuppressWarnings({"java:S106","java:S4823"}) @SuppressWarnings({"java:S106","java:S4823"})
public final class ModifyDocumentSummaryInformation { public final class ModifyDocumentSummaryInformation {

View File

@ -48,7 +48,7 @@ import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.poifs.filesystem.POIFSFileSystem; import org.apache.poi.poifs.filesystem.POIFSFileSystem;
/** /**
* A XLS -> CSV processor, that uses the MissingRecordAware * A XLS -&gt; CSV processor, that uses the MissingRecordAware
* EventModel code to ensure it outputs all columns and rows. * EventModel code to ensure it outputs all columns and rows.
* @author Nick Burch * @author Nick Burch
*/ */
@ -83,7 +83,7 @@ public class XLS2CSVmra implements HSSFListener {
private boolean outputNextStringRecord; private boolean outputNextStringRecord;
/** /**
* Creates a new XLS -> CSV converter * Creates a new XLS -&gt; CSV converter
* @param fs The POIFSFileSystem to process * @param fs The POIFSFileSystem to process
* @param output The PrintStream to output the CSV to * @param output The PrintStream to output the CSV to
* @param minColumns The minimum number of columns to output, or -1 for no minimum * @param minColumns The minimum number of columns to output, or -1 for no minimum
@ -95,9 +95,11 @@ public class XLS2CSVmra implements HSSFListener {
} }
/** /**
* Creates a new XLS -> CSV converter * Creates a new XLS -&gt; CSV converter
* @param filename The file to process * @param filename The file to process
* @param minColumns The minimum number of columns to output, or -1 for no minimum * @param minColumns The minimum number of columns to output, or -1 for no minimum
*
* @throws IOException if the file cannot be read or parsing the file fails
*/ */
public XLS2CSVmra(String filename, int minColumns) throws IOException { public XLS2CSVmra(String filename, int minColumns) throws IOException {
this( this(
@ -108,6 +110,8 @@ public class XLS2CSVmra implements HSSFListener {
/** /**
* Initiates the processing of the XLS file to CSV * Initiates the processing of the XLS file to CSV
*
* @throws IOException if the workbook contained errors
*/ */
public void process() throws IOException { public void process() throws IOException {
MissingRecordAwareHSSFListener listener = new MissingRecordAwareHSSFListener(this); MissingRecordAwareHSSFListener listener = new MissingRecordAwareHSSFListener(this);

View File

@ -43,7 +43,7 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook;
* A monthly calendar created using Apache POI. Each month is on a separate sheet. * A monthly calendar created using Apache POI. Each month is on a separate sheet.
* <pre> * <pre>
* Usage: * Usage:
* CalendarDemo -xls|xlsx <year> * CalendarDemo -xls|xlsx &lt;year&gt;
* </pre> * </pre>
* *
* @author Yegor Kozlov * @author Yegor Kozlov

View File

@ -40,7 +40,7 @@ import org.apache.poi.ss.usermodel.WorkbookFactory;
/** /**
* Demonstrates <em>one</em> way to convert an Excel spreadsheet into a CSV * Demonstrates <em>one</em> way to convert an Excel spreadsheet into a CSV
* file. This class makes the following assumptions; * file. This class makes the following assumptions;
* <list> * <ul>
* <li>1. Where the Excel workbook contains more than one worksheet, then a single * <li>1. Where the Excel workbook contains more than one worksheet, then a single
* CSV file will contain the data from all of the worksheets.</li> * CSV file will contain the data from all of the worksheets.</li>
* <li>2. The data matrix contained in the CSV file will be square. This means that * <li>2. The data matrix contained in the CSV file will be square. This means that
@ -51,7 +51,7 @@ import org.apache.poi.ss.usermodel.WorkbookFactory;
* <li>3. Empty fields will represent missing cells.</li> * <li>3. Empty fields will represent missing cells.</li>
* <li>4. A record consisting of empty fields will be used to represent an empty row * <li>4. A record consisting of empty fields will be used to represent an empty row
* in the Excel workbook.</li> * in the Excel workbook.</li>
* </list> * </ul>
* Therefore, if the worksheet looked like this; * Therefore, if the worksheet looked like this;
* *
* <pre> * <pre>

View File

@ -46,7 +46,7 @@ import org.xml.sax.SAXException;
import org.xml.sax.XMLReader; import org.xml.sax.XMLReader;
/** /**
* A rudimentary XLSX -> CSV processor modeled on the * A rudimentary XLSX -&gt; CSV processor modeled on the
* POI sample program XLS2CSVmra from the package * POI sample program XLS2CSVmra from the package
* org.apache.poi.hssf.eventusermodel.examples. * org.apache.poi.hssf.eventusermodel.examples.
* As with the HSSF version, this tries to spot missing * As with the HSSF version, this tries to spot missing
@ -171,7 +171,7 @@ public class XLSX2CSV {
private final PrintStream output; private final PrintStream output;
/** /**
* Creates a new XLSX -> CSV examples * Creates a new XLSX -&gt; CSV examples
* *
* @param pkg The XLSX package to process * @param pkg The XLSX package to process
* @param output The PrintStream to output the CSV to * @param output The PrintStream to output the CSV to

View File

@ -45,7 +45,7 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook;
* *
* <pre> * <pre>
* Usage: * Usage:
* CalendarDemo <year> * CalendarDemo &lt;year&gt;
* </pre> * </pre>
* *
* @author Yegor Kozlov * @author Yegor Kozlov

View File

@ -35,7 +35,7 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook;
* <p><ul> * <p><ul>
* <li>The example demonstrates that all temp files are removed. * <li>The example demonstrates that all temp files are removed.
* <li><code>AesZipFileZipEntrySource</code> is used to ensure that temp files are encrypted. * <li><code>AesZipFileZipEntrySource</code> is used to ensure that temp files are encrypted.
* </ul><p> * </ul></p>
*/ */
@SuppressWarnings({"java:S106","java:S4823","java:S1192"}) @SuppressWarnings({"java:S106","java:S4823","java:S1192"})
public final class LoadPasswordProtectedXlsx { public final class LoadPasswordProtectedXlsx {