aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobin Stocker <robin@nibor.org>2012-10-30 15:24:56 +0100
committerChris Aniszczyk <zx@twitter.com>2012-10-31 21:26:22 -0700
commitb7f5ed561249b8c224d2a8844832b9fbba6e9f41 (patch)
tree3f80f1ae6ccf9de10c415bb9b15bc4f5d121d5f4
parentcda5e861b98adc7078c9d3a38900dce9540e2127 (diff)
downloadjgit-b7f5ed561249b8c224d2a8844832b9fbba6e9f41.tar.gz
jgit-b7f5ed561249b8c224d2a8844832b9fbba6e9f41.zip
Add Javadoc description for packages
These appear as descriptions in the index, see here (currently empty): http://download.eclipse.org/jgit/docs/latest/apidocs/ Change-Id: If7996deef30ae688bade8b3ad6b19547ca3d8b50 Signed-off-by: Chris Aniszczyk <zx@twitter.com>
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/api/errors/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/api/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/blame/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/diff/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/dircache/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/errors/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/events/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/ignore/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/internal/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/lib/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/merge/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/nls/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/notes/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/patch/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/revplot/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/revwalk/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/storage/file/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/submodule/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/transport/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/transport/resolver/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/treewalk/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/util/io/package-info.java4
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/util/package-info.java4
28 files changed, 112 insertions, 0 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/errors/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/errors/package-info.java
new file mode 100644
index 0000000000..4066d1e75a
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/errors/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Exceptions thrown by API commands.
+ */
+package org.eclipse.jgit.api.errors;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/package-info.java
new file mode 100644
index 0000000000..f1e6571d50
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * High-level API commands (the porcelain of JGit).
+ */
+package org.eclipse.jgit.api;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/blame/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/blame/package-info.java
new file mode 100644
index 0000000000..05f6c5914f
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/blame/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Computing blame/annotate information of files.
+ */
+package org.eclipse.jgit.blame;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/diff/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/diff/package-info.java
new file mode 100644
index 0000000000..98c44e11a1
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/diff/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Comparing file contents by computing diffs.
+ */
+package org.eclipse.jgit.diff;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/package-info.java
new file mode 100644
index 0000000000..297065a077
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Reading and editing the directory cache (index).
+ */
+package org.eclipse.jgit.dircache;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/errors/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/errors/package-info.java
new file mode 100644
index 0000000000..44fd432b49
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/errors/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Exceptions thrown by lower-level JGit APIs.
+ */
+package org.eclipse.jgit.errors;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/package-info.java
new file mode 100644
index 0000000000..5cdb72307b
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Events and listener interfaces.
+ */
+package org.eclipse.jgit.events;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/package-info.java
new file mode 100644
index 0000000000..ba6753b606
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * File name matcher.
+ */
+package org.eclipse.jgit.fnmatch;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/package-info.java
new file mode 100644
index 0000000000..6797e98881
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Ignore rule parser/matcher (for .gitignore entries).
+ */
+package org.eclipse.jgit.ignore;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/package-info.java
new file mode 100644
index 0000000000..b78f8ebd17
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Internal classes.
+ */
+package org.eclipse.jgit.internal;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/package-info.java
new file mode 100644
index 0000000000..ce2711e02d
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Core API for repository, config, refs, object database.
+ */
+package org.eclipse.jgit.lib;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/merge/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/merge/package-info.java
new file mode 100644
index 0000000000..d61cd6a5cd
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/merge/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Content and commit history merge algorithms.
+ */
+package org.eclipse.jgit.merge;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/nls/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/nls/package-info.java
new file mode 100644
index 0000000000..0f2105a283
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/nls/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Native language support (i18n).
+ */
+package org.eclipse.jgit.nls;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/notes/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/notes/package-info.java
new file mode 100644
index 0000000000..1908b6609f
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/notes/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Git notes processing (for commits, etc).
+ */
+package org.eclipse.jgit.notes;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/patch/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/patch/package-info.java
new file mode 100644
index 0000000000..b8e18a6b5f
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/patch/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Patch file parser and data structure.
+ */
+package org.eclipse.jgit.patch;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/revplot/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/revplot/package-info.java
new file mode 100644
index 0000000000..8bec5f1f77
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/revplot/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Building/rendering revision graphs.
+ */
+package org.eclipse.jgit.revplot;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/package-info.java
new file mode 100644
index 0000000000..135850cba5
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Filters for use in revision walking.
+ */
+package org.eclipse.jgit.revwalk.filter;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/package-info.java
new file mode 100644
index 0000000000..05ab51e48f
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Walking revision graphs (commit history).
+ */
+package org.eclipse.jgit.revwalk;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/package-info.java
new file mode 100644
index 0000000000..32f3d32752
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Distributed file system based repository storage.
+ */
+package org.eclipse.jgit.storage.dfs;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/package-info.java
new file mode 100644
index 0000000000..9b3506b1db
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * File based repository storage.
+ */
+package org.eclipse.jgit.storage.file;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/package-info.java
new file mode 100644
index 0000000000..ac7d115e66
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Reading/writing Git pack files.
+ */
+package org.eclipse.jgit.storage.pack;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/submodule/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/submodule/package-info.java
new file mode 100644
index 0000000000..b5f70bb9b3
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/submodule/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Git submodule support.
+ */
+package org.eclipse.jgit.submodule;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/package-info.java
new file mode 100644
index 0000000000..e885384cc6
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Transport (fetch/push) for different protocols.
+ */
+package org.eclipse.jgit.transport;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/resolver/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/resolver/package-info.java
new file mode 100644
index 0000000000..63be596d92
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/resolver/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Server-side resolver for locating repositories by URLs.
+ */
+package org.eclipse.jgit.transport.resolver;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/package-info.java
new file mode 100644
index 0000000000..9044c511d3
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Filters for use in tree walking.
+ */
+package org.eclipse.jgit.treewalk.filter;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/package-info.java
new file mode 100644
index 0000000000..9e25f92aa2
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Walking and comparing directory/file trees (of commits, file system).
+ */
+package org.eclipse.jgit.treewalk;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/io/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/io/package-info.java
new file mode 100644
index 0000000000..70a4d816c5
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/io/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Utility classes for IO (streams).
+ */
+package org.eclipse.jgit.util.io;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/package-info.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/package-info.java
new file mode 100644
index 0000000000..88e827198f
--- /dev/null
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Utility classes.
+ */
+package org.eclipse.jgit.util;