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>
This commit is contained in:
Robin Stocker 2012-10-30 15:24:56 +01:00 committed by Chris Aniszczyk
parent cda5e861b9
commit b7f5ed5612
28 changed files with 112 additions and 0 deletions

View File

@ -0,0 +1,4 @@
/**
* Exceptions thrown by API commands.
*/
package org.eclipse.jgit.api.errors;

View File

@ -0,0 +1,4 @@
/**
* High-level API commands (the porcelain of JGit).
*/
package org.eclipse.jgit.api;

View File

@ -0,0 +1,4 @@
/**
* Computing blame/annotate information of files.
*/
package org.eclipse.jgit.blame;

View File

@ -0,0 +1,4 @@
/**
* Comparing file contents by computing diffs.
*/
package org.eclipse.jgit.diff;

View File

@ -0,0 +1,4 @@
/**
* Reading and editing the directory cache (index).
*/
package org.eclipse.jgit.dircache;

View File

@ -0,0 +1,4 @@
/**
* Exceptions thrown by lower-level JGit APIs.
*/
package org.eclipse.jgit.errors;

View File

@ -0,0 +1,4 @@
/**
* Events and listener interfaces.
*/
package org.eclipse.jgit.events;

View File

@ -0,0 +1,4 @@
/**
* File name matcher.
*/
package org.eclipse.jgit.fnmatch;

View File

@ -0,0 +1,4 @@
/**
* Ignore rule parser/matcher (for .gitignore entries).
*/
package org.eclipse.jgit.ignore;

View File

@ -0,0 +1,4 @@
/**
* Internal classes.
*/
package org.eclipse.jgit.internal;

View File

@ -0,0 +1,4 @@
/**
* Core API for repository, config, refs, object database.
*/
package org.eclipse.jgit.lib;

View File

@ -0,0 +1,4 @@
/**
* Content and commit history merge algorithms.
*/
package org.eclipse.jgit.merge;

View File

@ -0,0 +1,4 @@
/**
* Native language support (i18n).
*/
package org.eclipse.jgit.nls;

View File

@ -0,0 +1,4 @@
/**
* Git notes processing (for commits, etc).
*/
package org.eclipse.jgit.notes;

View File

@ -0,0 +1,4 @@
/**
* Patch file parser and data structure.
*/
package org.eclipse.jgit.patch;

View File

@ -0,0 +1,4 @@
/**
* Building/rendering revision graphs.
*/
package org.eclipse.jgit.revplot;

View File

@ -0,0 +1,4 @@
/**
* Filters for use in revision walking.
*/
package org.eclipse.jgit.revwalk.filter;

View File

@ -0,0 +1,4 @@
/**
* Walking revision graphs (commit history).
*/
package org.eclipse.jgit.revwalk;

View File

@ -0,0 +1,4 @@
/**
* Distributed file system based repository storage.
*/
package org.eclipse.jgit.storage.dfs;

View File

@ -0,0 +1,4 @@
/**
* File based repository storage.
*/
package org.eclipse.jgit.storage.file;

View File

@ -0,0 +1,4 @@
/**
* Reading/writing Git pack files.
*/
package org.eclipse.jgit.storage.pack;

View File

@ -0,0 +1,4 @@
/**
* Git submodule support.
*/
package org.eclipse.jgit.submodule;

View File

@ -0,0 +1,4 @@
/**
* Transport (fetch/push) for different protocols.
*/
package org.eclipse.jgit.transport;

View File

@ -0,0 +1,4 @@
/**
* Server-side resolver for locating repositories by URLs.
*/
package org.eclipse.jgit.transport.resolver;

View File

@ -0,0 +1,4 @@
/**
* Filters for use in tree walking.
*/
package org.eclipse.jgit.treewalk.filter;

View File

@ -0,0 +1,4 @@
/**
* Walking and comparing directory/file trees (of commits, file system).
*/
package org.eclipse.jgit.treewalk;

View File

@ -0,0 +1,4 @@
/**
* Utility classes for IO (streams).
*/
package org.eclipse.jgit.util.io;

View File

@ -0,0 +1,4 @@
/**
* Utility classes.
*/
package org.eclipse.jgit.util;