Author: fanningpj
Date: Thu Jun 7 07:40:09 2018
New Revision: 1833101
URL: http://svn.apache.org/viewvc?rev=1833101&view=rev
Log:
fix some javadoc
Modified:
poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java
poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java
Modified:
poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java?rev=1833101&r1=1833100&r2=1833101&view=diff
==============================================================================
---
poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java
(original)
+++
poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java
Thu Jun 7 07:40:09 2018
@@ -53,6 +53,10 @@ public final class PackagePartCollection
* recognize a part with a part name derived from another part name by
* appending segments to it.
*
+ * @param partName name of part
+ * @param part part to put
+ * @return the previous value associated with {@code partName}, or
+ * {@code null} if there was no mapping for {@code partName}.
* @exception InvalidOperationException
* Throws if you try to add a part with a name derived
from
* another part name.
@@ -89,6 +93,7 @@ public final class PackagePartCollection
/**
* The values themselves should be returned in sorted order. Doing it
here
* avoids paying the high cost of Natural Ordering per insertion.
+ * @return unmodifiable collection of parts
*/
public Collection<PackagePart> sortedValues() {
return
Collections.unmodifiableCollection(packagePartLookup.values());
Modified:
poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java?rev=1833101&r1=1833100&r2=1833101&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java
(original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java
Thu Jun 7 07:40:09 2018
@@ -489,6 +489,11 @@ public final class PackagePartName imple
* case-insensitive ASCII strings. Packages shall not contain equivalent
* part names and package implementers shall neither create nor recognize
* packages with equivalent part names. [M1.12]
+ *
+ * @param obj1 first {@code PackagePartName} to compare
+ * @param obj2 second {@code PackagePartName} to compare
+ * @return a negative integer, zero, or a positive integer as the first
argument is less than,
+ * equal to, or greater than the second.
*/
public static int compare(PackagePartName obj1, PackagePartName obj2) {
return compare (
@@ -506,6 +511,11 @@ public final class PackagePartName imple
* For example, this sorts "file10.png" after "file2.png" (comparing the
* numerical portion), but sorts "File10.png" before "file2.png"
* (lexigraphical sort)
+ *
+ * @param str1 first string to compare
+ * @param str1 second string to compare
+ * @return a negative integer, zero, or a positive integer as the first
argument is less than,
+ * equal to, or greater than the second.
*/
public static int compare(final String str1, final String str2)
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
