From 764ee71d00e17db31abd6bcc5812d6c774a6abb2 Mon Sep 17 00:00:00 2001
From: Georg Seibt <seibt@fim.uni-passau.de>
Date: Fri, 21 Oct 2016 15:00:21 +0200
Subject: [PATCH] some doc fixes and additions
---
.../uni_passau/fim/seibt/gitwrapper/repo/BlameLine.java | 1 -
src/de/uni_passau/fim/seibt/gitwrapper/repo/Branch.java | 4 ++--
src/de/uni_passau/fim/seibt/gitwrapper/repo/Commit.java | 5 ++---
.../fim/seibt/gitwrapper/repo/DummyCommit.java | 6 +++++-
.../uni_passau/fim/seibt/gitwrapper/repo/Reference.java | 9 +++++++++
src/de/uni_passau/fim/seibt/gitwrapper/repo/Status.java | 6 ++++++
6 files changed, 24 insertions(+), 7 deletions(-)
diff --git a/src/de/uni_passau/fim/seibt/gitwrapper/repo/BlameLine.java b/src/de/uni_passau/fim/seibt/gitwrapper/repo/BlameLine.java
index 18d260b..2e6d80a 100644
--- a/src/de/uni_passau/fim/seibt/gitwrapper/repo/BlameLine.java
+++ b/src/de/uni_passau/fim/seibt/gitwrapper/repo/BlameLine.java
@@ -7,7 +7,6 @@ import java.util.Map;
/**
* A line from a file with the associated 'git blame' information.
*/
-@SuppressWarnings("WeakerAccess")
public class BlameLine {
/**
diff --git a/src/de/uni_passau/fim/seibt/gitwrapper/repo/Branch.java b/src/de/uni_passau/fim/seibt/gitwrapper/repo/Branch.java
index f8bfa34..63b4798 100644
--- a/src/de/uni_passau/fim/seibt/gitwrapper/repo/Branch.java
+++ b/src/de/uni_passau/fim/seibt/gitwrapper/repo/Branch.java
@@ -7,14 +7,14 @@ import java.util.function.Function;
import java.util.logging.Logger;
/**
- * A {@link Branch} is a named {@link Reference} to a git branch pointing to an {@link Commit}.
+ * A {@link Branch} is a named {@link Reference} to a git branch pointing to a {@link Commit}.
*/
public class Branch extends Reference {
private static final Logger LOG = Logger.getLogger(Branch.class.getCanonicalName());
/**
- * Constructs an object referencing an existing git branch.
+ * Constructs a new {@link Branch} referencing an existing git branch.
*
* @param repo the repo this branch is part of
* @param name the branch name
diff --git a/src/de/uni_passau/fim/seibt/gitwrapper/repo/Commit.java b/src/de/uni_passau/fim/seibt/gitwrapper/repo/Commit.java
index 1dd75d7..a19e4a2 100644
--- a/src/de/uni_passau/fim/seibt/gitwrapper/repo/Commit.java
+++ b/src/de/uni_passau/fim/seibt/gitwrapper/repo/Commit.java
@@ -14,7 +14,7 @@ public class Commit extends Reference {
private static final Logger LOG = Logger.getLogger(Commit.class.getCanonicalName());
- // since there is no porcelain format for this command, this regex is might depend on the git version
+ // Regexes for parsing the 'git cat-file -p' output for a commit object. These might depend on the git version.
private static final Pattern TREE_INFO = Pattern.compile("tree (.{40})\\nparent (.{40})\\n");
private static final Pattern AUTHOR_INFO = Pattern.compile("author (.*?)<(.*?)> (\\d+) ([+-]\\d{4})\\n");
private static final Pattern COMMITTER_INFO = Pattern.compile("committer (.*?)<(.*?)> (\\d+) ([+-]\\d{4})\\n");
@@ -195,8 +195,7 @@ public class Commit extends Reference {
}
/**
- * Reads the author information (author, author mail, author time) about this commit and saves it in the
- * {@link Commit}.
+ * Initializes all uninitialized fields of this {@link Commit} from its 'git cat-file -p <id>' output.
*/
private void getCommitInfo() {
git.exec(repo.getDir(), "cat-file", "-p", id).ifPresent(execRes -> {
diff --git a/src/de/uni_passau/fim/seibt/gitwrapper/repo/DummyCommit.java b/src/de/uni_passau/fim/seibt/gitwrapper/repo/DummyCommit.java
index 5fc852d..21e8638 100644
--- a/src/de/uni_passau/fim/seibt/gitwrapper/repo/DummyCommit.java
+++ b/src/de/uni_passau/fim/seibt/gitwrapper/repo/DummyCommit.java
@@ -3,7 +3,11 @@ package de.uni_passau.fim.seibt.gitwrapper.repo;
import java.time.OffsetDateTime;
import java.util.logging.Logger;
-public class DummyCommit extends Commit {
+/**
+ * Represents the dummy commit that is used by git to represent uncommitted changes. Every {@link Repository}
+ * constructs its {@link DummyCommit} in its constructor.
+ */
+final class DummyCommit extends Commit {
private static final Logger LOG = Logger.getLogger(DummyCommit.class.getCanonicalName());
diff --git a/src/de/uni_passau/fim/seibt/gitwrapper/repo/Reference.java b/src/de/uni_passau/fim/seibt/gitwrapper/repo/Reference.java
index 55e6050..28ccd37 100644
--- a/src/de/uni_passau/fim/seibt/gitwrapper/repo/Reference.java
+++ b/src/de/uni_passau/fim/seibt/gitwrapper/repo/Reference.java
@@ -12,6 +12,7 @@ import java.util.stream.Collectors;
/**
* A git object referencing a tree-ish object.
+ *
* @see Commit
* @see Branch
*/
@@ -23,6 +24,14 @@ public abstract class Reference {
protected final Repository repo;
protected final GitWrapper git;
+ /**
+ * Constructs a new {@link Reference} belonging to the given {@code repo}.
+ *
+ * @param repo
+ * the {@link Repository} this {@link Reference} belongs to
+ * @param id
+ * the ID of the {@link Reference}
+ */
protected Reference(Repository repo, String id) {
this.id = id;
this.repo = repo;
diff --git a/src/de/uni_passau/fim/seibt/gitwrapper/repo/Status.java b/src/de/uni_passau/fim/seibt/gitwrapper/repo/Status.java
index 04d8087..155adfb 100644
--- a/src/de/uni_passau/fim/seibt/gitwrapper/repo/Status.java
+++ b/src/de/uni_passau/fim/seibt/gitwrapper/repo/Status.java
@@ -9,7 +9,13 @@ import java.util.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+/**
+ * The status of a {@link Repository}.
+ *
+ * @see Repository#getStatus()
+ */
public class Status {
+
private static final Pattern STATUS_ENTRY = Pattern.compile("(.?.) (?:.*? )?(.*?)\0");
/**
--
GitLab