Minor JavaDoc corrections

coherence-community · Mar 26, 2017 · b8513eb · b8513eb
1 parent c463038
commit b8513eb
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git a/....7.1-testing-support/src/main/java/com/oracle/bedrock/junit/CoherenceClusterResource.java b/....7.1-testing-support/src/main/java/com/oracle/bedrock/junit/CoherenceClusterResource.java
@@ -101,7 +101,7 @@ protected AssemblyBuilder<CoherenceClusterMember, CoherenceCluster> createBuilde
 
 
     /**
-     * Obtains the {@link CoherenceCluster} created by the {@link CoherenceClusterResource <R>}.
+     * Obtains the {@link CoherenceCluster} created by the {@link CoherenceClusterResource}.
      *
      * @return the {@link CoherenceCluster}
      */

diff --git a/bedrock-core/src/main/java/com/oracle/bedrock/diagnostics/DiagnosticsRecording.java b/bedrock-core/src/main/java/com/oracle/bedrock/diagnostics/DiagnosticsRecording.java
@@ -234,6 +234,8 @@ public DiagnosticsRecording using(Logger logger,
     /**
      * Creates a new {@link DiagnosticsRecording} with the specified name.
      *
+     * @param name the name of the {@link DiagnosticsRecording}
+     *
      * @return a new {@link DiagnosticsRecording}
      */
     public static DiagnosticsRecording create(String name)
@@ -265,6 +267,8 @@ public static DiagnosticsRecording continued()
      * Creates a nested {@link DiagnosticsRecording} section with a specified name.  If there's no previously defined
      * {@link DiagnosticsRecording}, a new {@link DiagnosticsRecording} with the specified name will be created.
      *
+     * @param name the name of the {@link DiagnosticsRecording} section
+     *
      * @return a new {@link DiagnosticsRecording}
      */
     public static DiagnosticsRecording section(String name)

diff --git a/bedrock-core/src/main/java/com/oracle/bedrock/util/Pair.java b/bedrock-core/src/main/java/com/oracle/bedrock/util/Pair.java
@@ -83,6 +83,9 @@ public Pair(X x,
      * @param x  the first value of the {@link Pair}
      * @param y  the second value of the {@link Pair}
      *
+     * @param <X>  the type of the first value of the {@link Pair}
+     * @param <Y>  the type of the second value of the {@link Pair}
+     *
      * @return a {@link Pair}
      */
     public static <X, Y> Pair<X, Y> of(X x,

diff --git a/bedrock-runtime/src/main/java/com/oracle/bedrock/runtime/OperatingSystem.java b/bedrock-runtime/src/main/java/com/oracle/bedrock/runtime/OperatingSystem.java
@@ -385,9 +385,11 @@ public String getPathSeparator()
 
 
     /**
-     * Determines the {@link String}the {@link OperatingSystem} uses to separate individual lines of text.
+     * Determines the {@link String} the {@link OperatingSystem} uses to separate individual lines of text.
      * <p>
      * eg: On *unix this is "\n", on Windows it is "\r\n"
+     *
+     * @return the line separator
      */
     public String getLineSeparator()
     {
@@ -541,6 +543,9 @@ public static OperatingSystem local()
      * Determines the {@link OperatingSystem} based on the Java System Property
      * defined os.name and os.version.
      *
+     * @param osName     the operating system name
+     * @param osVersion  the operating system version
+     *
      * @return the {@link OperatingSystem}
      */
     public static OperatingSystem from(String osName,