diff options
| author | Jonathan Nieder <jrn@google.com> | 2013-05-29 10:42:35 -0700 |
|---|---|---|
| committer | Jonathan Nieder <jrn@google.com> | 2013-05-29 12:36:36 -0700 |
| commit | 659cadf06d165f1a31a0466689d77dff7330f99d (patch) | |
| tree | 5eac8fd1ecd7b8b14d11b1366c7b176258879b56 /org.eclipse.jgit.archive/src | |
| parent | 79583aeba7819de28f1e70723713e59595e6ff18 (diff) | |
| download | jgit-659cadf06d165f1a31a0466689d77dff7330f99d.tar.gz jgit-659cadf06d165f1a31a0466689d77dff7330f99d.zip | |
Add missing javadoc for archive code
Document archive formats, the archive format interface, and the
parameters of the GitAPIException constructors. Noticed by eclipse.
Reported-by: Dani Megert <Daniel_Megert@ch.ibm.com>
Change-Id: I22b5f9d4c0358bbe867c1906feec7c279e214273
Diffstat (limited to 'org.eclipse.jgit.archive/src')
5 files changed, 25 insertions, 0 deletions
diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/FormatActivator.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/FormatActivator.java index f2f6140256..c8ea28eeff 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/FormatActivator.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/FormatActivator.java @@ -56,10 +56,23 @@ import org.osgi.framework.BundleContext; * leaks). */ public class FormatActivator implements BundleActivator { + /** + * Registers all included archive formats by calling + * {@link #start()}. This method is called by the OSGi framework + * when the bundle is started. + * + * @param context unused + */ public void start(BundleContext context) { ArchiveFormats.registerAll(); } + /** + * Cleans up after {@link #start(BundleContext)} by calling + * {@link #stop()}. + * + * @param context unused + */ public void stop(BundleContext context) { ArchiveFormats.unregisterAll(); } diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java index 2e5683c2b5..3b27489e26 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java @@ -53,6 +53,9 @@ import org.eclipse.jgit.api.ArchiveCommand; import org.eclipse.jgit.lib.FileMode; import org.eclipse.jgit.lib.ObjectLoader; +/** + * Unix TAR format (ustar + old GNU long filename extension). + */ public class TarFormat implements ArchiveCommand.Format<ArchiveOutputStream> { public ArchiveOutputStream createArchiveOutputStream(OutputStream s) { return new TarArchiveOutputStream(s); diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java index d68cb68e8b..1c72bf8dcc 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java @@ -51,6 +51,9 @@ import org.eclipse.jgit.api.ArchiveCommand; import org.eclipse.jgit.lib.FileMode; import org.eclipse.jgit.lib.ObjectLoader; +/** + * gzip-compressed tarball (tar.gz) format. + */ public class TgzFormat implements ArchiveCommand.Format<ArchiveOutputStream> { private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat(); diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java index 622571f983..d1547c683c 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java @@ -51,6 +51,9 @@ import org.eclipse.jgit.api.ArchiveCommand; import org.eclipse.jgit.lib.FileMode; import org.eclipse.jgit.lib.ObjectLoader; +/** + * Xz-compressed tar (tar.xz) format. + */ public class TxzFormat implements ArchiveCommand.Format<ArchiveOutputStream> { private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat(); diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java index 19328775a4..a0906d4dd5 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java @@ -52,6 +52,9 @@ import org.eclipse.jgit.api.ArchiveCommand; import org.eclipse.jgit.lib.FileMode; import org.eclipse.jgit.lib.ObjectLoader; +/** + * PKWARE's ZIP format. + */ public class ZipFormat implements ArchiveCommand.Format<ArchiveOutputStream> { public ArchiveOutputStream createArchiveOutputStream(OutputStream s) { return new ZipArchiveOutputStream(s); |