summaryrefslogtreecommitdiff
path: root/src/proguard/classfile/package.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/proguard/classfile/package.html')
-rw-r--r--src/proguard/classfile/package.html15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/proguard/classfile/package.html b/src/proguard/classfile/package.html
new file mode 100644
index 0000000..fad087c
--- /dev/null
+++ b/src/proguard/classfile/package.html
@@ -0,0 +1,15 @@
+<body>
+This package contains classes to represent the various elements of class files.
+<p>
+A class file is represented by the <code>{@link proguard.classfile.ClassFile
+ClassFile}</code> interface. This interface currently has two alternative
+representations:
+<ul>
+<li><code>{@link ProgramClassFile ProgramClassFile}</code>:
+ a complete representation that can be read, modified, and written back.
+<li><code>{@link LibraryClassFile LibraryClassFile}</code>:
+ an incomplete representation that can be only be read. It is however
+ more compact than <code>ProgramClassFile</code>, and sufficient for
+ analyzing class files from library jars.
+</ul>
+</body>