Merge pull request #183 from offa/javadoc

Fix some Javadoc issues
jenkinsci · Jan 4, 2023 · 8f4e7ab · 8f4e7ab
2 parents d6ddf12 + 103daea
commit 8f4e7ab
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/src/main/java/jenkins/scm/api/SCMFileSystem.java b/src/main/java/jenkins/scm/api/SCMFileSystem.java
@@ -124,7 +124,7 @@ public final boolean isFixedRevision() {
      * Short for {@code getRoot().child(path)}.
      *
      * @param path Path of the SCMFile to obtain from the root of the repository.
-     * @return null if there's no file/directory at the requested path.
+     * @return Child path
      */
     @NonNull
     public final SCMFile child(@NonNull String path) {

diff --git a/src/main/java/jenkins/scm/api/SCMSource.java b/src/main/java/jenkins/scm/api/SCMSource.java
@@ -61,11 +61,11 @@
  * A {@link SCMSource} is responsible for fetching {@link SCMHead} and corresponding {@link SCMRevision} instances from
  * which it can build {@link SCM} instances that are configured to check out the specific {@link SCMHead} at the
  * specified {@link SCMRevision}.
- *
+ * <p>
  * Each {@link SCMSource} is owned by a {@link SCMSourceOwner}, if you need to find all the owners use
  * {@link SCMSourceOwners#all()} to iterate through them, e.g. to notify {@link SCMSource} instances of push
  * notification from the server they source {@link SCMHead}s from.
- *
+ * <p>
  * <strong>NOTE:</strong> This layer does not cache remote calls but can cache intermediary results. For example,
  * with Subversion it is acceptable to cache the last revisions of various directory entries to minimize network
  * round trips, but any of the calls to {@link #fetch(TaskListener)},
@@ -994,7 +994,7 @@ public boolean canProbe() {
 
     /**
      * Creates a {@link SCMProbe} for the specified {@link SCMHead} and {@link SCMRevision}.
-     *
+     * <p>
      * Public exposed API for {@link #createProbe(SCMHead, SCMRevision)}.
      * @param head the {@link SCMHead}.
      * @param revision the {@link SCMRevision}.

diff --git a/src/main/java/jenkins/scm/impl/avatars/AvatarImageSource.java b/src/main/java/jenkins/scm/impl/avatars/AvatarImageSource.java
@@ -26,7 +26,7 @@
 /**
  *
  * Interface for Avatar Cache Item Source
- * 
+ * <p>
  * This defines a source for avatar to be ached and implementation to fetch it
  */
 public interface AvatarImageSource {