diff options
author | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-21 01:36:18 +0100 |
---|---|---|
committer | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-21 02:42:14 +0100 |
commit | 2464fa440f7585154c591d3a12f6778026da40ff (patch) | |
tree | a0621370cecd9c7695aa983b7cd6d08dc7f1f092 /org.eclipse.jgit | |
parent | 73f8e887c3ca3a81d41ce0e33b139439098e9f26 (diff) | |
download | jgit-2464fa440f7585154c591d3a12f6778026da40ff.tar.gz jgit-2464fa440f7585154c591d3a12f6778026da40ff.zip |
Fix remaining javadoc errors raised by doclint
For now ignore doclint "missing" warnings.
Change-Id: I0e5af7a757f4d92ffeeb113f30576a35414d6781
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Diffstat (limited to 'org.eclipse.jgit')
17 files changed, 20 insertions, 23 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/PushCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/PushCommand.java index e1d99460f3..19bdd35778 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/PushCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/PushCommand.java @@ -331,8 +331,7 @@ public class PushCommand extends } /** - * Get <code>RefSpec</code>s. - * </p> + * Get {@code RefSpec}s. * * @return the ref specs */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attribute.java b/org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attribute.java index 5842e14cd8..f1df0da453 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attribute.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attribute.java @@ -58,7 +58,6 @@ package org.eclipse.jgit.attributes; * following (with lower priority) nodes from setting the attribute to a value * at all</li> * </ul> - * </p> * * @since 3.7 */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attributes.java b/org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attributes.java index 5fcd596a6c..125ee5961a 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attributes.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attributes.java @@ -53,7 +53,6 @@ import org.eclipse.jgit.lib.Constants; /** * Represents a set of attributes for a path - * <p> * * @since 4.2 */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/FastIgnoreRule.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/FastIgnoreRule.java index 8abd7fa920..460f0ed4b1 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/FastIgnoreRule.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/FastIgnoreRule.java @@ -55,7 +55,7 @@ import org.slf4j.LoggerFactory; /** * "Fast" (compared with IgnoreRule) git ignore rule implementation supporting - * also double star <code>**<code> pattern. + * also double star {@code **} pattern. * <p> * This class is immutable and thread safe. * diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsGarbageCollector.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsGarbageCollector.java index 637ce16277..69989a451e 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsGarbageCollector.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsGarbageCollector.java @@ -289,7 +289,7 @@ public class DfsGarbageCollector { * * @return garbage packs older than this limit (in milliseconds) will be * pruned as part of the garbage collection process if the value is - * > 0, otherwise garbage packs are retained. + * > 0, otherwise garbage packs are retained. */ public long getGarbageTtlMillis() { return garbageTtlMillis; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java index 89801c5438..c1fbe65de8 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java @@ -1448,7 +1448,7 @@ public class GC { * it exits without performing any work. Some JGit commands run * {@code gc --auto} after performing operations that could create many * loose objects. - * <p/> + * <p> * Housekeeping is required if there are too many loose objects or too many * packs in the repository. If the number of loose objects exceeds the value * of the gc.auto option JGit GC consolidates all existing packs into a @@ -1456,13 +1456,13 @@ public class GC { * combine all loose objects into a single pack using {@code repack -d -l}. * Setting the value of {@code gc.auto} to 0 disables automatic packing of * loose objects. - * <p/> + * <p> * If the number of packs exceeds the value of {@code gc.autoPackLimit}, * then existing packs (except those marked with a .keep file) are * consolidated into a single pack by using the {@code -A} option of repack. * Setting {@code gc.autoPackLimit} to 0 disables automatic consolidation of * packs. - * <p/> + * <p> * Like git the following jgit commands run auto gc: * <ul> * <li>fetch</li> diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/BranchConfig.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/BranchConfig.java index 6b8553cdfa..596da0349c 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/BranchConfig.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/BranchConfig.java @@ -159,7 +159,7 @@ public class BranchConfig { } /** - * Get the remote this branch is configured to fetch from/push to> + * Get the remote this branch is configured to fetch from/push to * * @return the remote this branch is configured to fetch from/push to, or * {@code null} if not defined diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java index fda670bbb0..8c448af904 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java @@ -1431,10 +1431,10 @@ public abstract class Repository implements AutoCloseable { * Normalizes the passed branch name into a possible valid branch name. The * validity of the returned name should be checked by a subsequent call to * {@link #isValidRefName(String)}. - * <p/> + * <p> * Future implementations of this method could be more restrictive or more * lenient about the validity of specific characters in the returned name. - * <p/> + * <p> * The current implementation returns the trimmed input string if this is * already a valid branch name. Otherwise it returns a trimmed string with * special characters not allowed by {@link #isValidRefName(String)} @@ -2079,7 +2079,7 @@ public abstract class Repository implements AutoCloseable { * collection; if not, exit without performing any work. Some JGit commands * run autoGC after performing operations that could create many loose * objects. - * <p/> + * <p> * Currently this option is supported for repositories of type * {@code FileRepository} only. See * {@link org.eclipse.jgit.internal.storage.file.GC#setAuto(boolean)} for diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java b/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java index 06a63109b3..1d970db948 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java @@ -81,7 +81,7 @@ import org.eclipse.jgit.util.FS; public class SubmoduleWalk implements AutoCloseable { /** - * The values for the config param submodule.<name>.ignore + * The values for the config parameter submodule.<name>.ignore * * @since 3.6 */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/HttpConfig.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/HttpConfig.java index 368bdc913c..101ce35685 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/HttpConfig.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/HttpConfig.java @@ -63,8 +63,8 @@ import org.slf4j.LoggerFactory; /** * A representation of the "http.*" config values in a git * {@link org.eclipse.jgit.lib.Config}. git provides for setting values for - * specific URLs through "http.<url>.* subsections. git always considers only - * the initial original URL for such settings, not any redirected URL. + * specific URLs through "http.<url>.*" subsections. git always considers + * only the initial original URL for such settings, not any redirected URL. * * @since 4.9 */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/URIish.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/URIish.java index f96d2698e1..a41e47ec82 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/URIish.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/URIish.java @@ -689,7 +689,7 @@ public class URIish implements Serializable { } /** - * <Get the URI as an ASCII string. + * Get the URI as an ASCII string. * * @return the URI as an ASCII string. Password is not included. */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/TreeWalk.java b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/TreeWalk.java index 0a0fe70da2..a91ad592cf 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/TreeWalk.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/TreeWalk.java @@ -549,7 +549,7 @@ public class TreeWalk implements AutoCloseable, AttributesProvider { * <p> * Retrieve the git attributes for the current entry. * - * <h4>Git attribute computation</h4> + * <h3>Git attribute computation</h3> * * <ul> * <li>Get the attributes matching the current path entry from the info file @@ -568,7 +568,7 @@ public class TreeWalk implements AutoCloseable, AttributesProvider { * </ul> * * - * <h4>Iterator constraints</h4> + * <h3>Iterator constraints</h3> * * <p> * In order to have a correct list of attributes for the current entry, this diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java index a1c479553e..08c278e38a 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java @@ -575,7 +575,6 @@ public class FileUtils { * </pre> * * This will return "..\\another_project\\pom.xml". - * </p> * * <p> * <b>Note</b> that this will return the empty String if <code>base</code> diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/LongMap.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/LongMap.java index e00289247e..09eee42024 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/LongMap.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/LongMap.java @@ -44,7 +44,7 @@ package org.eclipse.jgit.util; /** - * Simple Map<long,Object>. + * Simple Map<long, Object>. * * @param <V> * type of the value instance. diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java index fdb6600d01..b4736d3e40 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java @@ -107,7 +107,7 @@ public final class StringUtils { * {@link java.lang.Character#toTitleCase(char)}. No other letters are * changed. * </p> - * + * <p> * A <code>null</code> input String returns <code>null</code>. * </p> * diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolStreamTypeUtil.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolStreamTypeUtil.java index e5b3fa55e2..822961f8de 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolStreamTypeUtil.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolStreamTypeUtil.java @@ -70,6 +70,7 @@ public final class EolStreamTypeUtil { * <li>global attributes</li> * <li>info attributes</li> * <li>working tree .gitattributes</li> + * </ul> * * @param op * is the diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/time/MonotonicClock.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/time/MonotonicClock.java index 1d4f5e8405..c7c874d2ac 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/time/MonotonicClock.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/time/MonotonicClock.java @@ -65,7 +65,7 @@ import java.time.Duration; * } * * try (ProposedTimestamp t2 = clk.propose()) { - * assert t2.millis() > r1; + * assert t2.millis() > r1; * } * </pre> * |