fix some javadoc

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1833101 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java
index f1227de436a3b743297477f9ed0fed009b22e171..f295aad99ccf157f2e0d09c227b4d69a95562a3e 100644 (file)
--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java
+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java
@@ -53,6 +53,10 @@ public final class PackagePartCollection implements Serializable {
         * 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 implements Serializable {
        /**
         * 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());

diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java
index db3ee057e5255745896f12f2eb1e9da03f49a056..baee7e2abd804920b38a8034177dd6ba038a02b7 100644 (file)
--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java
+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java
@@ -489,6 +489,11 @@ public final class PackagePartName implements Comparable<PackagePartName> {
      * 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 implements Comparable<PackagePartName> {
      * 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)
     {