From a90b75b47aff1c7139056352bf0145858ea3742c Mon Sep 17 00:00:00 2001 From: Matthias Sohn Date: Sun, 17 Dec 2017 19:50:13 +0100 Subject: [PATCH] Fix javadoc in org.eclipse.jgit.junit Change-Id: I1107e6a82849ac329361baabb5c481d86ea6dc9e Signed-off-by: Matthias Sohn --- .../src/org/eclipse/jgit/junit/Assert.java | 21 ++++ .../org/eclipse/jgit/junit/JGitTestUtil.java | 74 ++++++++++++ .../junit/LocalDiskRepositoryTestCase.java | 44 ++++++- .../eclipse/jgit/junit/MockSystemReader.java | 26 ++++- .../src/org/eclipse/jgit/junit/Repeat.java | 6 + .../org/eclipse/jgit/junit/RepeatRule.java | 5 +- .../jgit/junit/RepositoryTestCase.java | 109 +++++++++++++++++- .../eclipse/jgit/junit/StrictWorkMonitor.java | 8 ++ .../eclipse/jgit/junit/TestRepository.java | 42 +++++-- .../src/org/eclipse/jgit/junit/TestRng.java | 6 +- .../jgit/junit/time/MonotonicFakeClock.java | 4 +- 11 files changed, 323 insertions(+), 22 deletions(-) diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/Assert.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/Assert.java index 40a05b4b7c..57b33e1c4f 100644 --- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/Assert.java +++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/Assert.java @@ -44,12 +44,33 @@ package org.eclipse.jgit.junit; import static java.lang.Boolean.valueOf; +/** + * Assertion class + */ public class Assert { + /** + * Assert booleans are equal + * + * @param expect + * expected value + * @param actual + * actual value + */ public static void assertEquals(boolean expect, boolean actual) { org.junit.Assert.assertEquals(valueOf(expect), valueOf(actual)); } + /** + * Assert booleans are equal + * + * @param message + * message + * @param expect + * expected value + * @param actual + * actual value + */ public static void assertEquals(String message, boolean expect, boolean actual) { org.junit.Assert diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/JGitTestUtil.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/JGitTestUtil.java index 5bf61f0e83..4ba2606fb3 100644 --- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/JGitTestUtil.java +++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/JGitTestUtil.java @@ -64,13 +64,22 @@ import org.eclipse.jgit.util.RawParseUtils; import org.junit.Assert; import org.junit.Test; +/** + * Abstract test util class + */ public abstract class JGitTestUtil { + /** Constant CLASSPATH_TO_RESOURCES="org/eclipse/jgit/test/resources/" */ public static final String CLASSPATH_TO_RESOURCES = "org/eclipse/jgit/test/resources/"; private JGitTestUtil() { throw new UnsupportedOperationException(); } + /** + * Get name of current test by inspecting stack trace + * + * @return the name + */ public static String getName() { GatherStackTrace stack; try { @@ -109,6 +118,14 @@ public abstract class JGitTestUtil { // Thrown above to collect the stack frame. } + /** + * Assert byte arrays are equal + * + * @param exp + * expected value + * @param act + * actual value + */ public static void assertEquals(byte[] exp, byte[] act) { Assert.assertEquals(s(exp), s(act)); } @@ -117,6 +134,12 @@ public abstract class JGitTestUtil { return RawParseUtils.decode(raw); } + /** + * Get test resource file. + * + * @param fileName + * @return the test resource file + */ public static File getTestResourceFile(final String fileName) { if (fileName == null || fileName.length() <= 0) { return null; @@ -145,6 +168,13 @@ public abstract class JGitTestUtil { } } + /** + * Copy test resource. + * + * @param name + * @param dest + * @throws IOException + */ public static void copyTestResource(String name, File dest) throws IOException { URL url = cl().getResource(CLASSPATH_TO_RESOURCES + name); @@ -169,6 +199,15 @@ public abstract class JGitTestUtil { return JGitTestUtil.class.getClassLoader(); } + /** + * Write a trash file. + * + * @param db + * @param name + * @param data + * @return the trash file + * @throws IOException + */ public static File writeTrashFile(final Repository db, final String name, final String data) throws IOException { File path = new File(db.getWorkTree(), name); @@ -176,6 +215,16 @@ public abstract class JGitTestUtil { return path; } + /** + * Write a trash file. + * + * @param db + * @param subdir + * @param name + * @param data + * @return the trash file + * @throws IOException + */ public static File writeTrashFile(final Repository db, final String subdir, final String name, final String data) throws IOException { @@ -224,17 +273,40 @@ public abstract class JGitTestUtil { return new String(body, 0, body.length, "UTF-8"); } + /** + * Read a file's content + * + * @param db + * @param name + * @return the content of the file + * @throws IOException + */ public static String read(final Repository db, final String name) throws IOException { File file = new File(db.getWorkTree(), name); return read(file); } + /** + * Check if file exists + * + * @param db + * @param name + * name of the file + * @return {@code true} if the file exists + */ public static boolean check(final Repository db, final String name) { File file = new File(db.getWorkTree(), name); return file.exists(); } + /** + * Delete a trash file. + * + * @param db + * @param name + * @throws IOException + */ public static void deleteTrashFile(final Repository db, final String name) throws IOException { File path = new File(db.getWorkTree(), name); @@ -242,6 +314,8 @@ public abstract class JGitTestUtil { } /** + * Write a symbolic link + * * @param db * the repository * @param link diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java index 6ace9fc122..9dac11e5bc 100644 --- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java +++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java @@ -82,8 +82,9 @@ import org.junit.Before; * A temporary directory is created for each test, allowing each test to use a * fresh environment. The temporary directory is cleaned up after the test ends. *

- * Callers should not use {@link RepositoryCache} from within these tests as it - * may wedge file descriptors open past the end of the test. + * Callers should not use {@link org.eclipse.jgit.lib.RepositoryCache} from + * within these tests as it may wedge file descriptors open past the end of the + * test. *

* A system property {@code jgit.junit.usemmap} defines whether memory mapping * is used. Memory mapping has an effect on the file system, in that memory @@ -112,6 +113,11 @@ public abstract class LocalDiskRepositoryTestCase { private final Set toClose = new HashSet<>(); private File tmp; + /** + * Setup test + * + * @throws Exception + */ @Before public void setUp() throws Exception { tmp = File.createTempFile("jgit_test_", "_tmp"); @@ -142,10 +148,20 @@ public abstract class LocalDiskRepositoryTestCase { c.install(); } + /** + * Get temporary directory. + * + * @return the temporary directory + */ protected File getTemporaryDirectory() { return tmp.getAbsoluteFile(); } + /** + * Get list of ceiling directories + * + * @return list of ceiling directories + */ protected List getCeilings() { return Collections.singletonList(getTemporaryDirectory()); } @@ -164,6 +180,11 @@ public abstract class LocalDiskRepositoryTestCase { return stringBuilder.toString(); } + /** + * Tear down the test + * + * @throws Exception + */ @After public void tearDown() throws Exception { RepositoryCache.clear(); @@ -185,7 +206,9 @@ public abstract class LocalDiskRepositoryTestCase { SystemReader.setInstance(null); } - /** Increment the {@link #author} and {@link #committer} times. */ + /** + * Increment the {@link #author} and {@link #committer} times. + */ protected void tick() { mockSystemReader.tick(5 * 60); final long now = mockSystemReader.getCurrentTime(); @@ -239,16 +262,22 @@ public abstract class LocalDiskRepositoryTestCase { System.err.println(msg); } + /** Constant MOD_TIME=1 */ public static final int MOD_TIME = 1; + /** Constant SMUDGE=2 */ public static final int SMUDGE = 2; + /** Constant LENGTH=4 */ public static final int LENGTH = 4; + /** Constant CONTENT_ID=8 */ public static final int CONTENT_ID = 8; + /** Constant CONTENT=16 */ public static final int CONTENT = 16; + /** Constant ASSUME_UNCHANGED=32 */ public static final int ASSUME_UNCHANGED = 32; /** @@ -279,7 +308,6 @@ public abstract class LocalDiskRepositoryTestCase { * * @param repo * the repository the index state should be determined for - * * @param includedOptions * a bitmask constructed out of the constants {@link #MOD_TIME}, * {@link #SMUDGE}, {@link #LENGTH}, {@link #CONTENT_ID} and @@ -546,6 +574,14 @@ public abstract class LocalDiskRepositoryTestCase { JGitTestUtil.write(f, body); } + /** + * Read a file's content + * + * @param f + * the file + * @return the content of the file + * @throws IOException + */ protected String read(final File f) throws IOException { return JGitTestUtil.read(f); } diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/MockSystemReader.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/MockSystemReader.java index 68482c6c27..05d15229bc 100644 --- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/MockSystemReader.java +++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/MockSystemReader.java @@ -67,7 +67,7 @@ import org.eclipse.jgit.util.time.MonotonicClock; import org.eclipse.jgit.util.time.ProposedTimestamp; /** - * Mock {@link SystemReader} for tests. + * Mock {@link org.eclipse.jgit.util.SystemReader} for tests. */ public class MockSystemReader extends SystemReader { private final class MockConfig extends FileBasedConfig { @@ -94,6 +94,9 @@ public class MockSystemReader extends SystemReader { FileBasedConfig systemGitConfig; + /** + * Constructor for MockSystemReader + */ public MockSystemReader() { init(Constants.OS_USER_NAME_KEY); init(Constants.GIT_AUTHOR_NAME_KEY); @@ -110,46 +113,62 @@ public class MockSystemReader extends SystemReader { setProperty(n, n); } + /** + * Clear properties + */ public void clearProperties() { values.clear(); } + /** + * Set a property + * + * @param key + * @param value + */ public void setProperty(String key, String value) { values.put(key, value); } + /** {@inheritDoc} */ @Override public String getenv(String variable) { return values.get(variable); } + /** {@inheritDoc} */ @Override public String getProperty(String key) { return values.get(key); } + /** {@inheritDoc} */ @Override public FileBasedConfig openUserConfig(Config parent, FS fs) { assert parent == null || parent == systemGitConfig; return userGitConfig; } + /** {@inheritDoc} */ @Override public FileBasedConfig openSystemConfig(Config parent, FS fs) { assert parent == null; return systemGitConfig; } + /** {@inheritDoc} */ @Override public String getHostname() { return "fake.host.example.com"; } + /** {@inheritDoc} */ @Override public long getCurrentTime() { return now; } + /** {@inheritDoc} */ @Override public MonotonicClock getClock() { return new MonotonicClock() { @@ -182,26 +201,31 @@ public class MockSystemReader extends SystemReader { now += secDelta * 1000L; } + /** {@inheritDoc} */ @Override public int getTimezone(long when) { return getTimeZone().getOffset(when) / (60 * 1000); } + /** {@inheritDoc} */ @Override public TimeZone getTimeZone() { return TimeZone.getTimeZone("GMT-03:30"); } + /** {@inheritDoc} */ @Override public Locale getLocale() { return Locale.US; } + /** {@inheritDoc} */ @Override public SimpleDateFormat getSimpleDateFormat(String pattern) { return new SimpleDateFormat(pattern, getLocale()); } + /** {@inheritDoc} */ @Override public DateFormat getDateTimeInstance(int dateStyle, int timeStyle) { return DateFormat diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/Repeat.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/Repeat.java index a3c869f722..b2521a1375 100644 --- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/Repeat.java +++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/Repeat.java @@ -46,8 +46,14 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * Interface enabling to run tests repeatedly + */ @Retention(RetentionPolicy.RUNTIME) @Target({ java.lang.annotation.ElementType.METHOD }) public @interface Repeat { + /** + * Number of repetitions + */ public abstract int n(); } diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepeatRule.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepeatRule.java index 4230073c1b..8165738ed8 100644 --- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepeatRule.java +++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepeatRule.java @@ -51,8 +51,8 @@ import org.junit.runner.Description; import org.junit.runners.model.Statement; /** - * {@link TestRule} which enables to run the same JUnit test repeatedly. Add - * this rule to the test class + * {@link org.junit.rules.TestRule} which enables to run the same JUnit test + * repeatedly. Add this rule to the test class * *

  * public class MyTest {
@@ -118,6 +118,7 @@ public class RepeatRule implements TestRule {
 		}
 	}
 
+	/** {@inheritDoc} */
 	@Override
 	public Statement apply(Statement statement, Description description) {
 		Statement result = statement;
diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepositoryTestCase.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepositoryTestCase.java
index c282df03bd..044f08072a 100644
--- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepositoryTestCase.java
+++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepositoryTestCase.java
@@ -84,6 +84,13 @@ import org.junit.Before;
  * repositories and destroying them when the tests are finished.
  */
 public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
+	/**
+	 * Copy a file
+	 *
+	 * @param src
+	 * @param dst
+	 * @throws IOException
+	 */
 	protected static void copyFile(final File src, final File dst)
 			throws IOException {
 		final FileInputStream fis = new FileInputStream(src);
@@ -103,6 +110,14 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 		}
 	}
 
+	/**
+	 * Write a trash file
+	 *
+	 * @param name
+	 * @param data
+	 * @return the trash file
+	 * @throws IOException
+	 */
 	protected File writeTrashFile(final String name, final String data)
 			throws IOException {
 		return JGitTestUtil.writeTrashFile(db, name, data);
@@ -124,24 +139,62 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 		return JGitTestUtil.writeLink(db, link, target);
 	}
 
+	/**
+	 * Write a trash file
+	 *
+	 * @param subdir
+	 * @param name
+	 * @param data
+	 * @return the trash file
+	 * @throws IOException
+	 */
 	protected File writeTrashFile(final String subdir, final String name,
 			final String data)
 			throws IOException {
 		return JGitTestUtil.writeTrashFile(db, subdir, name, data);
 	}
 
+	/**
+	 * Read content of a file
+	 *
+	 * @param name
+	 * @return the file's content
+	 * @throws IOException
+	 */
 	protected String read(final String name) throws IOException {
 		return JGitTestUtil.read(db, name);
 	}
 
+	/**
+	 * Check if file exists
+	 *
+	 * @param name
+	 *            file name
+	 * @return if the file exists
+	 */
 	protected boolean check(final String name) {
 		return JGitTestUtil.check(db, name);
 	}
 
+	/**
+	 * Delete a trash file
+	 *
+	 * @param name
+	 *            file name
+	 * @throws IOException
+	 */
 	protected void deleteTrashFile(final String name) throws IOException {
 		JGitTestUtil.deleteTrashFile(db, name);
 	}
 
+	/**
+	 * Check content of a file.
+	 *
+	 * @param f
+	 * @param checkData
+	 *            expected content
+	 * @throws IOException
+	 */
 	protected static void checkFile(File f, final String checkData)
 			throws IOException {
 		Reader r = new InputStreamReader(new FileInputStream(f), "UTF-8");
@@ -161,6 +214,7 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 	/** Working directory of {@link #db}. */
 	protected File trash;
 
+	/** {@inheritDoc} */
 	@Override
 	@Before
 	public void setUp() throws Exception {
@@ -220,8 +274,8 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 	 * have an index which matches their prepared content.
 	 *
 	 * @param treeItr
-	 *            a {@link FileTreeIterator} which determines which files should
-	 *            go into the new index
+	 *            a {@link org.eclipse.jgit.treewalk.FileTreeIterator} which
+	 *            determines which files should go into the new index
 	 * @throws FileNotFoundException
 	 * @throws IOException
 	 */
@@ -261,13 +315,13 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 	 *
 	 * @param l
 	 *            the object to lookup
+	 * @param lookupTable
+	 *            a table storing object-name mappings.
 	 * @param nameTemplate
 	 *            the name for that object. Can contain "%n" which will be
 	 *            replaced by a running number before used as a name. If the
 	 *            lookup table already contains the object this parameter will
 	 *            be ignored
-	 * @param lookupTable
-	 *            a table storing object-name mappings.
 	 * @return a name of that object. Is not guaranteed to be unique. Use
 	 *         nameTemplates containing "%n" to always have unique names
 	 */
@@ -288,7 +342,7 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 	 * @param str
 	 *            the string in which backslashes should be replaced
 	 * @return the resulting string with slashes
-         * @since 4.2
+	 * @since 4.2
 	 */
 	public static String slashify(String str) {
 		str = str.replace('\\', '/');
@@ -335,6 +389,13 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 		}
 	}
 
+	/**
+	 * Create a branch
+	 *
+	 * @param objectId
+	 * @param branchName
+	 * @throws IOException
+	 */
 	protected void createBranch(ObjectId objectId, String branchName)
 			throws IOException {
 		RefUpdate updateRef = db.updateRef(branchName);
@@ -342,6 +403,13 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 		updateRef.update();
 	}
 
+	/**
+	 * Checkout a branch
+	 *
+	 * @param branchName
+	 * @throws IllegalStateException
+	 * @throws IOException
+	 */
 	protected void checkoutBranch(String branchName)
 			throws IllegalStateException, IOException {
 		try (RevWalk walk = new RevWalk(db)) {
@@ -429,15 +497,39 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 		}
 	}
 
+	/**
+	 * Create DirCacheEntry
+	 *
+	 * @param path
+	 * @param mode
+	 * @return the DirCacheEntry
+	 */
 	protected DirCacheEntry createEntry(final String path, final FileMode mode) {
 		return createEntry(path, mode, DirCacheEntry.STAGE_0, path);
 	}
 
+	/**
+	 * Create DirCacheEntry
+	 *
+	 * @param path
+	 * @param mode
+	 * @param content
+	 * @return the DirCacheEntry
+	 */
 	protected DirCacheEntry createEntry(final String path, final FileMode mode,
 			final String content) {
 		return createEntry(path, mode, DirCacheEntry.STAGE_0, content);
 	}
 
+	/**
+	 * Create DirCacheEntry
+	 *
+	 * @param path
+	 * @param mode
+	 * @param stage
+	 * @param content
+	 * @return the DirCacheEntry
+	 */
 	protected DirCacheEntry createEntry(final String path, final FileMode mode,
 			final int stage, final String content) {
 		final DirCacheEntry entry = new DirCacheEntry(path, stage);
@@ -449,6 +541,13 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
 		return entry;
 	}
 
+	/**
+	 * Assert files are equal
+	 *
+	 * @param expected
+	 * @param actual
+	 * @throws IOException
+	 */
 	public static void assertEqualsFile(File expected, File actual)
 			throws IOException {
 		assertEquals(expected.getCanonicalFile(), actual.getCanonicalFile());
diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/StrictWorkMonitor.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/StrictWorkMonitor.java
index 22b69a3ee5..fcedfb0186 100644
--- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/StrictWorkMonitor.java
+++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/StrictWorkMonitor.java
@@ -47,30 +47,38 @@ import static org.junit.Assert.assertEquals;
 
 import org.eclipse.jgit.lib.ProgressMonitor;
 
+/**
+ * Strict work monitor
+ */
 public final class StrictWorkMonitor implements ProgressMonitor {
 	private int lastWork, totalWork;
 
+	/** {@inheritDoc} */
 	@Override
 	public void start(int totalTasks) {
 		// empty
 	}
 
+	/** {@inheritDoc} */
 	@Override
 	public void beginTask(String title, int total) {
 		this.totalWork = total;
 		lastWork = 0;
 	}
 
+	/** {@inheritDoc} */
 	@Override
 	public void update(int completed) {
 		lastWork += completed;
 	}
 
+	/** {@inheritDoc} */
 	@Override
 	public void endTask() {
 		assertEquals("Units of work recorded", totalWork, lastWork);
 	}
 
+	/** {@inheritDoc} */
 	@Override
 	public boolean isCancelled() {
 		return false;
diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/TestRepository.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/TestRepository.java
index db6f60960c..41634e7cda 100644
--- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/TestRepository.java
+++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/TestRepository.java
@@ -114,12 +114,16 @@ import org.eclipse.jgit.util.FileUtils;
  */
 public class TestRepository {
 
+	/** Constant AUTHOR="J. Author" */
 	public static final String AUTHOR = "J. Author";
 
+	/** Constant AUTHOR_EMAIL="jauthor@example.com" */
 	public static final String AUTHOR_EMAIL = "jauthor@example.com";
 
+	/** Constant COMMITTER="J. Committer" */
 	public static final String COMMITTER = "J. Committer";
 
+	/** Constant COMMITTER_EMAIL="jcommitter@example.com" */
 	public static final String COMMITTER_EMAIL = "jcommitter@example.com";
 
 	private final PersonIdent defaultAuthor;
@@ -186,25 +190,38 @@ public class TestRepository {
 		defaultCommitter = new PersonIdent(COMMITTER, COMMITTER_EMAIL, now, tz);
 	}
 
-	/** @return the repository this helper class operates against. */
+	/**
+	 * Get repository
+	 *
+	 * @return the repository this helper class operates against.
+	 */
 	public R getRepository() {
 		return db;
 	}
 
-	/** @return get the RevWalk pool all objects are allocated through. */
+	/**
+	 * Get RevWalk
+	 *
+	 * @return get the RevWalk pool all objects are allocated through.
+	 */
 	public RevWalk getRevWalk() {
 		return pool;
 	}
 
 	/**
+	 * Return Git API wrapper
+	 *
 	 * @return an API wrapper for the underlying repository. This wrapper does
-	 *         not allocate any new resources and need not be closed (but closing
-	 *         it is harmless). */
+	 *         not allocate any new resources and need not be closed (but
+	 *         closing it is harmless).
+	 */
 	public Git git() {
 		return git;
 	}
 
 	/**
+	 * Get date
+	 *
 	 * @return current date.
 	 * @since 4.2
 	 */
@@ -212,7 +229,11 @@ public class TestRepository {
 		return new Date(mockSystemReader.getCurrentTime());
 	}
 
-	/** @return timezone used for default identities. */
+	/**
+	 * Get timezone
+	 *
+	 * @return timezone used for default identities.
+	 */
 	public TimeZone getTimeZone() {
 		return mockSystemReader.getTimeZone();
 	}
@@ -424,7 +445,11 @@ public class TestRepository {
 		return pool.lookupCommit(id);
 	}
 
-	/** @return a new commit builder. */
+	/**
+	 * Create commit builder
+	 *
+	 * @return a new commit builder.
+	 */
 	public CommitBuilder commit() {
 		return new CommitBuilder();
 	}
@@ -618,7 +643,7 @@ public class TestRepository {
 
 	/**
 	 * Soft-reset HEAD to a detached state.
-	 * 

+ * * @param id * ID of detached head. * @throws Exception @@ -758,7 +783,8 @@ public class TestRepository { * Ensure the body of the given object has been parsed. * * @param - * type of object, e.g. {@link RevTag} or {@link RevCommit}. + * type of object, e.g. {@link org.eclipse.jgit.revwalk.RevTag} + * or {@link org.eclipse.jgit.revwalk.RevCommit}. * @param object * reference to the (possibly unparsed) object to force body * parsing of. diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/TestRng.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/TestRng.java index 93facc3777..54c81f2d86 100644 --- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/TestRng.java +++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/TestRng.java @@ -43,7 +43,9 @@ package org.eclipse.jgit.junit; -/** Toy RNG to ensure we get predictable numbers during unit tests. */ +/** + * Toy RNG to ensure we get predictable numbers during unit tests. + */ public class TestRng { private int next; @@ -74,6 +76,8 @@ public class TestRng { } /** + * Next int + * * @return the next random integer. */ public int nextInt() { diff --git a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/time/MonotonicFakeClock.java b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/time/MonotonicFakeClock.java index f09d303d55..1f5cac65c7 100644 --- a/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/time/MonotonicFakeClock.java +++ b/org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/time/MonotonicFakeClock.java @@ -50,7 +50,8 @@ import org.eclipse.jgit.util.time.MonotonicClock; import org.eclipse.jgit.util.time.ProposedTimestamp; /** - * Fake {@link MonotonicClock} for testing code that uses Clock. + * Fake {@link org.eclipse.jgit.util.time.MonotonicClock} for testing code that + * uses Clock. * * @since 4.6 */ @@ -72,6 +73,7 @@ public class MonotonicFakeClock implements MonotonicClock { now += unit.toMillis(add); } + /** {@inheritDoc} */ @Override public ProposedTimestamp propose() { long t = now++; -- 2.39.5