Author: centic
Date: Thu Feb 24 18:12:39 2022
New Revision: 1898385
URL: http://svn.apache.org/viewvc?rev=1898385&view=rev
Log:
Add/update some JavaDoc
Modified:
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hemf/usermodel/HemfPicture.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hmef/HMEFMessage.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/Bitmap.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/DIB.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/EMF.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/JPEG.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PICT.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PNG.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/WMF.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPictureData.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hwmf/usermodel/HwmfPicture.java
poi/trunk/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java
Modified:
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java
(original)
+++
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java
Thu Feb 24 18:12:39 2022
@@ -48,11 +48,11 @@ public final class PackageHelper {
}
/**
- * @param stream
+ * @param stream The InputStream to read from
* @param closeStream whether to close the stream (default is false)
* @since POI 5.2.0
* @return OPCPackage
- * @throws IOException
+ * @throws IOException If reading data from the stream fails
*/
public static OPCPackage open(InputStream stream, boolean closeStream)
throws IOException {
try {
Modified:
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
(original)
+++
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
Thu Feb 24 18:12:39 2022
@@ -128,7 +128,7 @@ public class XMLSlideShow extends POIXML
/**
* @param is InputStream
- * @throws IOException
+ * @throws IOException If reading data from the stream fails
* @throws POIXMLException a RuntimeException that can be caused by
invalid OOXML data
* @throws RuntimeException a number of other runtime exceptions can be
thrown, especially if there are problems with the
* input format
Modified:
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java
(original)
+++
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java
Thu Feb 24 18:12:39 2022
@@ -119,7 +119,9 @@ public class XSSFReader {
/**
* Controls whether {@link #getSharedStringsTable()} uses {@link
SharedStringsTable}
* or {@link ReadOnlySharedStringsTable}.
- * @param useReadOnlySharedStringsTable
+ *
+ * @param useReadOnlySharedStringsTable if true, the
ReadOnlySharedStringsTable is used,
+ * SharedStringsTable otherwise
* @since POI 5.2.0
*/
public void setUseReadOnlySharedStringsTable(boolean
useReadOnlySharedStringsTable) {
Modified:
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
(original)
+++
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
Thu Feb 24 18:12:39 2022
@@ -244,7 +244,7 @@ public class XSSFWorkbook extends POIXML
* footprint than an InputStream backed one.
*
* @param pkg the OpenXML4J {@code OPC Package} object.
- * @throws IOException
+ * @throws IOException If reading data from the package fails
* @throws POIXMLException a RuntimeException that can be caused by
invalid OOXML data
* @throws RuntimeException a number of other runtime exceptions can be
thrown, especially if there are problems with the
* input format
@@ -276,7 +276,7 @@ public class XSSFWorkbook extends POIXML
* pkg.close(); // gracefully closes the underlying zip file
* }</pre>
*
- * @throws IOException
+ * @throws IOException If reading data from the stream fails
* @throws POIXMLException a RuntimeException that can be caused by
invalid OOXML data
* @throws RuntimeException a number of other runtime exceptions can be
thrown, especially if there are problems with the
* input format
@@ -300,8 +300,8 @@ public class XSSFWorkbook extends POIXML
* than opening from an InputStream
*
* @param file the file to open
- * @throws IOException
- * @throws InvalidFormatException
+ * @throws IOException If reading data from the file fails
+ * @throws InvalidFormatException If the file has a format that cannot be
read or if the file is corrupted
* @throws POIXMLException a RuntimeException that can be caused by
invalid OOXML data
* @throws RuntimeException a number of other runtime exceptions can be
thrown, especially if there are problems with the
* input format
@@ -322,7 +322,7 @@ public class XSSFWorkbook extends POIXML
* than opening from an InputStream
*
* @param path the file name.
- * @throws IOException
+ * @throws IOException If reading data from the file fails
* @throws POIXMLException a RuntimeException that can be caused by
invalid OOXML data
* @throws RuntimeException a number of other runtime exceptions can be
thrown, especially if there are problems with the
* input format
@@ -335,7 +335,7 @@ public class XSSFWorkbook extends POIXML
/**
* Constructs a XSSFWorkbook object using Package Part.
* @param part package part
- * @throws IOException
+ * @throws IOException If reading data from the Package Part fails
* @throws POIXMLException a RuntimeException that can be caused by
invalid OOXML data
* @throws RuntimeException a number of other runtime exceptions can be
thrown, especially if there are problems with the
* input format
Modified:
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
(original)
+++
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
Thu Feb 24 18:12:39 2022
@@ -133,7 +133,7 @@ public class XWPFDocument extends POIXML
/**
* @param pkg OPC package
- * @throws IOException
+ * @throws IOException If reading data from the package fails
* @throws POIXMLException a RuntimeException that can be caused by
invalid OOXML data
* @throws RuntimeException a number of other runtime exceptions can be
thrown, especially if there are problems with the
* input format
@@ -146,8 +146,8 @@ public class XWPFDocument extends POIXML
}
/**
- * @param is InputStream
- * @throws IOException
+ * @param is The InputStream to read data from
+ * @throws IOException If reading data from the stream fails
* @throws POIXMLException a RuntimeException that can be caused by
invalid OOXML data
* @throws RuntimeException a number of other runtime exceptions can be
thrown, especially if there are problems with the
* input format
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hemf/usermodel/HemfPicture.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hemf/usermodel/HemfPicture.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hemf/usermodel/HemfPicture.java
(original)
+++
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hemf/usermodel/HemfPicture.java
Thu Feb 24 18:12:39 2022
@@ -208,8 +208,9 @@ public class HemfPicture implements Iter
}
/**
- * @param ctx
- * @param graphicsBounds
+ * @param ctx The Graphics-context to draw on
+ * @param graphicsBounds A rectangle which describes the bounds
+ * for drawing
* @throws IllegalStateException if the draw fails
*/
public void draw(Graphics2D ctx, Rectangle2D graphicsBounds) {
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hmef/HMEFMessage.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hmef/HMEFMessage.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
--- poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hmef/HMEFMessage.java
(original)
+++ poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hmef/HMEFMessage.java
Thu Feb 24 18:12:39 2022
@@ -41,7 +41,7 @@ import org.apache.poi.util.LittleEndian;
*/
public final class HMEFMessage {
public static final int HEADER_SIGNATURE = 0x223e9f78;
-
+
@SuppressWarnings("unused")
private int fileId;
private final List<TNEFAttribute> messageAttributes = new ArrayList<>();
@@ -50,7 +50,7 @@ public final class HMEFMessage {
/**
* @param inp input stream
- * @throws IOException
+ * @throws IOException If reading data from the stream fails
* @throws RuntimeException a number of runtime exceptions can be thrown,
especially if there are problems with the
* input format
*/
@@ -64,17 +64,17 @@ public final class HMEFMessage {
"expected " + HEADER_SIGNATURE + " but got " + sig
);
}
-
+
// Read the File ID
fileId = LittleEndian.readUShort(inp);
-
+
// Now begin processing the contents
process(inp);
} finally {
inp.close();
}
}
-
+
private void process(InputStream inp) throws IOException {
int level;
do {
@@ -126,16 +126,16 @@ public final class HMEFMessage {
Attachment attach = attachments.get(attachments.size() - 1);
attach.addAttribute(attr);
}
-
+
/**
- * Returns all HMEF/TNEF attributes of the message.
+ * Returns all HMEF/TNEF attributes of the message.
* Note - In a typical message, most of the interesting properties
- * are stored as {@link MAPIAttribute}s - see {@link
#getMessageMAPIAttributes()}
+ * are stored as {@link MAPIAttribute}s - see {@link
#getMessageMAPIAttributes()}
*/
public List<TNEFAttribute> getMessageAttributes() {
return Collections.unmodifiableList(messageAttributes);
}
-
+
/**
* Returns all MAPI attributes of the message.
* Note - A small number of HMEF/TNEF specific attributes normally
@@ -144,17 +144,17 @@ public final class HMEFMessage {
public List<MAPIAttribute> getMessageMAPIAttributes() {
return Collections.unmodifiableList(mapiAttributes);
}
-
+
/**
* Returns all the Attachments of the message.
*/
public List<Attachment> getAttachments() {
return Collections.unmodifiableList(attachments);
}
-
+
/**
* Return the message attribute with the given ID,
- * or null if there isn't one.
+ * or null if there isn't one.
*/
public TNEFAttribute getMessageAttribute(TNEFProperty id) {
for (TNEFAttribute attr : messageAttributes) {
@@ -164,10 +164,10 @@ public final class HMEFMessage {
}
return null;
}
-
+
/**
* Return the message MAPI Attribute with the given ID,
- * or null if there isn't one.
+ * or null if there isn't one.
*/
public MAPIAttribute getMessageMAPIAttribute(MAPIProperty id) {
for (MAPIAttribute attr : mapiAttributes) {
@@ -178,7 +178,7 @@ public final class HMEFMessage {
}
return null;
}
-
+
/**
* Return the string value of the mapi property, or null
* if it isn't set
@@ -186,7 +186,7 @@ public final class HMEFMessage {
private String getString(MAPIProperty id) {
return MAPIStringAttribute.getAsString( getMessageMAPIAttribute(id) );
}
-
+
/**
* Returns the Message Subject, or null if the mapi property
* for this isn't set
@@ -194,7 +194,7 @@ public final class HMEFMessage {
public String getSubject() {
return getString(MAPIProperty.CONVERSATION_TOPIC);
}
-
+
/**
* Returns the Message Body, as RTF, or null if the mapi property
* for this isn't set
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/Bitmap.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/Bitmap.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
--- poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/Bitmap.java
(original)
+++ poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/Bitmap.java
Thu Feb 24 18:12:39 2022
@@ -41,7 +41,7 @@ import org.apache.poi.util.Units;
public abstract class Bitmap extends HSLFPictureData {
/**
- * @deprecated Use {@link HSLFSlideShow#addPicture(byte[], PictureType)}
or one of its overloads to create new
+ * @deprecated Use {@link HSLFSlideShow#addPicture(byte[],
org.apache.poi.sl.usermodel.PictureData.PictureType)} or one of its overloads
to create new
* {@link Bitmap}. This API led to detached {@link Bitmap}
instances (See Bugzilla
* 46122) and prevented adding additional functionality.
*/
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/DIB.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/DIB.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
--- poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/DIB.java
(original)
+++ poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/DIB.java
Thu Feb 24 18:12:39 2022
@@ -37,7 +37,7 @@ public final class DIB extends Bitmap {
private static final int HEADER_SIZE = 14;
/**
- * @deprecated Use {@link HSLFSlideShow#addPicture(byte[], PictureType)}
or one of its overloads to create new
+ * @deprecated Use {@link HSLFSlideShow#addPicture(byte[],
org.apache.poi.sl.usermodel.PictureData.PictureType)} or one of its overloads
to create new
* {@link DIB}. This API led to detached {@link DIB} instances
(See Bugzilla
* 46122) and prevented adding additional functionality.
*/
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/EMF.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/EMF.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
--- poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/EMF.java
(original)
+++ poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/EMF.java
Thu Feb 24 18:12:39 2022
@@ -40,7 +40,7 @@ import org.apache.poi.util.Units;
public final class EMF extends Metafile {
/**
- * @deprecated Use {@link HSLFSlideShow#addPicture(byte[], PictureType)}
or one of its overloads to create new
+ * @deprecated Use {@link HSLFSlideShow#addPicture(byte[],
org.apache.poi.sl.usermodel.PictureData.PictureType)} or one of its overloads
to create new
* EMF. This API led to detached EMF instances (See Bugzilla
* 46122) and prevented adding additional functionality.
*/
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/JPEG.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/JPEG.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
--- poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/JPEG.java
(original)
+++ poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/JPEG.java
Thu Feb 24 18:12:39 2022
@@ -34,7 +34,7 @@ public final class JPEG extends Bitmap {
private ColorSpace colorSpace = ColorSpace.rgb;
/**
- * @deprecated Use {@link HSLFSlideShow#addPicture(byte[], PictureType)}
or one of its overloads to create new
+ * @deprecated Use {@link HSLFSlideShow#addPicture(byte[],
org.apache.poi.sl.usermodel.PictureData.PictureType)} or one of its overloads
to create new
* {@link JPEG}. This API led to detached {@link JPEG}
instances (See Bugzilla
* 46122) and prevented adding additional functionality.
*/
@@ -55,7 +55,7 @@ public final class JPEG extends Bitmap {
public JPEG(EscherContainerRecord recordContainer, EscherBSERecord bse) {
super(recordContainer, bse);
}
-
+
@Override
public PictureType getType(){
return PictureType.JPEG;
@@ -64,13 +64,13 @@ public final class JPEG extends Bitmap {
public ColorSpace getColorSpace() {
return colorSpace;
}
-
+
public void setColorSpace(ColorSpace colorSpace) {
this.colorSpace = colorSpace;
}
-
+
/**
- * JPEG signature is one of {@code 0x46A0, 0x46B0, 0x6E20, 0x6E30}
+ * JPEG signature is one of {@code 0x46A0, 0x46B0, 0x6E20, 0x6E30}
*
* @return JPEG signature ({@code 0x46A0, 0x46B0, 0x6E20, 0x6E30})
*/
@@ -79,7 +79,7 @@ public final class JPEG extends Bitmap {
? (getUIDInstanceCount() == 1 ? 0x46A0 : 0x46B0)
: (getUIDInstanceCount() == 1 ? 0x6E20 : 0x6E30);
}
-
+
/**
* Sets the PICT signature - either {@code 0x5420} or {@code 0x5430}
*/
@@ -103,6 +103,6 @@ public final class JPEG extends Bitmap {
break;
default:
throw new IllegalArgumentException(signature+" is not a valid
instance/signature value for JPEG");
- }
+ }
}
}
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PICT.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PICT.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
--- poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PICT.java
(original)
+++ poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PICT.java
Thu Feb 24 18:12:39 2022
@@ -47,7 +47,7 @@ public final class PICT extends Metafile
private static final Logger LOG = LogManager.getLogger(PICT.class);
/**
- * @deprecated Use {@link HSLFSlideShow#addPicture(byte[], PictureType)}
or one of its overloads to create new
+ * @deprecated Use {@link HSLFSlideShow#addPicture(byte[],
org.apache.poi.sl.usermodel.PictureData.PictureType)} or one of its overloads
to create new
* PICT. This API led to detached PICT instances (See Bugzilla
* 46122) and prevented adding additional functionality.
*/
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PNG.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PNG.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
--- poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PNG.java
(original)
+++ poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/PNG.java
Thu Feb 24 18:12:39 2022
@@ -30,7 +30,7 @@ import org.apache.poi.util.Removal;
public final class PNG extends Bitmap {
/**
- * @deprecated Use {@link HSLFSlideShow#addPicture(byte[], PictureType)}
or one of its overloads to create new
+ * @deprecated Use {@link HSLFSlideShow#addPicture(byte[],
org.apache.poi.sl.usermodel.PictureData.PictureType)} or one of its overloads
to create new
* {@link PNG}. This API led to detached {@link PNG} instances
(See Bugzilla
* 46122) and prevented adding additional functionality.
*/
@@ -70,7 +70,7 @@ public final class PNG extends Bitmap {
public int getSignature(){
return (getUIDInstanceCount() == 1 ? 0x6E00 : 0x6E10);
}
-
+
/**
* Sets the PNG signature - either {@code 0x6E00} or {@code 0x6E10}
*/
@@ -84,6 +84,6 @@ public final class PNG extends Bitmap {
break;
default:
throw new IllegalArgumentException(signature+" is not a valid
instance/signature value for PNG");
- }
+ }
}
}
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/WMF.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/WMF.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
--- poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/WMF.java
(original)
+++ poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/blip/WMF.java
Thu Feb 24 18:12:39 2022
@@ -40,7 +40,7 @@ import org.apache.poi.util.Units;
public final class WMF extends Metafile {
/**
- * @deprecated Use {@link HSLFSlideShow#addPicture(byte[], PictureType)}
or one of its overloads to create new
+ * @deprecated Use {@link HSLFSlideShow#addPicture(byte[],
org.apache.poi.sl.usermodel.PictureData.PictureType)} or one of its overloads
to create new
* WMF. This API led to detached WMF instances (See Bugzilla
* 46122) and prevented adding additional functionality.
*/
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPictureData.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPictureData.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPictureData.java
(original)
+++
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPictureData.java
Thu Feb 24 18:12:39 2022
@@ -110,7 +110,7 @@ public abstract class HSLFPictureData im
final EscherBSERecord bse;
/**
- * @deprecated Use {@link HSLFSlideShow#addPicture(byte[], PictureType)}
or one of its overloads to create new
+ * @deprecated Use {@link HSLFSlideShow#addPicture(byte[],
org.apache.poi.sl.usermodel.PictureData.PictureType)} or one of its overloads
to create new
* {@link HSLFPictureData}. This API led to detached {@link
HSLFPictureData} instances (See Bugzilla
* 46122) and prevented adding additional functionality.
*/
@@ -252,7 +252,7 @@ public abstract class HSLFPictureData im
*
* @param type type of picture.
* @return concrete instance of {@link HSLFPictureData}.
- * @deprecated Use {@link HSLFSlideShow#addPicture(byte[], PictureType)}
or one of its overloads to create new
+ * @deprecated Use {@link HSLFSlideShow#addPicture(byte[],
org.apache.poi.sl.usermodel.PictureData.PictureType)} or one of its overloads
to create new
* {@link HSLFPictureData}. This API led to detached {@link
HSLFPictureData} instances (See Bugzilla
* 46122) and prevented adding additional functionality.
*/
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java
(original)
+++
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java
Thu Feb 24 18:12:39 2022
@@ -166,7 +166,7 @@ public final class HSLFSlideShow extends
/**
* Constructs a Powerpoint document from an input stream.
- * @throws IOException
+ * @throws IOException If reading data from the stream fails
* @throws RuntimeException a number of runtime exceptions can be thrown,
especially if there are problems with the
* input format
*/
@@ -177,7 +177,7 @@ public final class HSLFSlideShow extends
/**
* Constructs a Powerpoint document from an POIFSFileSystem.
- * @throws IOException
+ * @throws IOException If reading data from the file-system fails
* @throws RuntimeException a number of runtime exceptions can be thrown,
especially if there are problems with the
* input format
*/
@@ -188,7 +188,7 @@ public final class HSLFSlideShow extends
/**
* Constructs a Powerpoint document from an DirectoryNode.
- * @throws IOException
+ * @throws IOException If reading data from the DirectoryNode fails
* @throws RuntimeException a number of runtime exceptions can be thrown,
especially if there are problems with the
* input format
*/
Modified:
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hwmf/usermodel/HwmfPicture.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hwmf/usermodel/HwmfPicture.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hwmf/usermodel/HwmfPicture.java
(original)
+++
poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hwmf/usermodel/HwmfPicture.java
Thu Feb 24 18:12:39 2022
@@ -81,8 +81,8 @@ public class HwmfPicture implements Iter
}
/**
- * @param inputStream
- * @throws IOException
+ * @param inputStream The InputStream to read data from
+ * @throws IOException If reading data from the file fails
* @throws RuntimeException a number of runtime exceptions can be thrown,
especially if there are problems with the
* input format
*/
Modified:
poi/trunk/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java
URL:
http://svn.apache.org/viewvc/poi/trunk/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java?rev=1898385&r1=1898384&r2=1898385&view=diff
==============================================================================
---
poi/trunk/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java
(original)
+++
poi/trunk/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java
Thu Feb 24 18:12:39 2022
@@ -195,7 +195,7 @@ public class POIFSFileSystem extends Blo
*
* @param channel the FileChannel from which to read the data
* @throws IOException on errors reading, or on invalid data
- * @see POIFSFileSystem(FileChannel, boolean, boolean) this constructor
gives more control over whether to
+ * @see #POIFSFileSystem(FileChannel, boolean, boolean) this constructor
gives more control over whether to
* close the provided channel
*/
public POIFSFileSystem(FileChannel channel)
@@ -215,7 +215,7 @@ public class POIFSFileSystem extends Blo
* @param channel the FileChannel from which to read or read/write the
data
* @param readOnly whether the POIFileSystem will only be used in
read-only mode
* @throws IOException on errors reading, or on invalid data
- * @see POIFSFileSystem(FileChannel, boolean, boolean) this constructor
gives more control over whether to
+ * @see #POIFSFileSystem(FileChannel, boolean, boolean) this constructor
gives more control over whether to
* close the provided channel
*/
public POIFSFileSystem(FileChannel channel, boolean readOnly)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
