diff --git a/checkstyle.xml b/checkstyle.xml
index 3e06aaf5..538b210c 100644
--- a/checkstyle.xml
+++ b/checkstyle.xml
@@ -92,6 +92,9 @@
+
+
+
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinElementHandler.java b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinElementHandler.java
index 5a784d57..bacec1f3 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinElementHandler.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinElementHandler.java
@@ -44,6 +44,10 @@ import org.spongepowered.tools.MirrorUtils;
import org.spongepowered.tools.obfuscation.interfaces.IMixinAnnotationProcessor;
import org.spongepowered.tools.obfuscation.interfaces.IObfuscationManager;
+/**
+ * Base class for module for {@link AnnotatedMixin} which handle different
+ * aspects of mixin target classes
+ */
abstract class AnnotatedMixinElementHandler {
/**
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinInjectorHandler.java b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinInjectorHandler.java
index 96fa77c6..075c34e0 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinInjectorHandler.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinInjectorHandler.java
@@ -42,6 +42,9 @@ import org.spongepowered.tools.MirrorUtils;
import org.spongepowered.tools.obfuscation.interfaces.IMixinAnnotationProcessor;
import org.spongepowered.tools.obfuscation.struct.Message;
+/**
+ * A module for {@link AnnotatedMixin} whic handles injectors
+ */
class AnnotatedMixinInjectorHandler extends AnnotatedMixinElementHandler {
AnnotatedMixinInjectorHandler(IMixinAnnotationProcessor ap, AnnotatedMixin mixin) {
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinOverwriteHandler.java b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinOverwriteHandler.java
index 6165d6b2..1c3ebf5e 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinOverwriteHandler.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinOverwriteHandler.java
@@ -34,6 +34,9 @@ import org.spongepowered.asm.obfuscation.SrgMethod;
import org.spongepowered.tools.MirrorUtils;
import org.spongepowered.tools.obfuscation.interfaces.IMixinAnnotationProcessor;
+/**
+ * A module for {@link AnnotatedMixin} which handles method overwrites
+ */
class AnnotatedMixinOverwriteHandler extends AnnotatedMixinElementHandler {
AnnotatedMixinOverwriteHandler(IMixinAnnotationProcessor ap, AnnotatedMixin mixin) {
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinShadowHandler.java b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinShadowHandler.java
index 561181d9..e470d299 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinShadowHandler.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixinShadowHandler.java
@@ -33,6 +33,9 @@ import org.spongepowered.asm.obfuscation.SrgMethod;
import org.spongepowered.tools.MirrorUtils;
import org.spongepowered.tools.obfuscation.interfaces.IMixinAnnotationProcessor;
+/**
+ * A module for {@link AnnotatedMixin} which handles shadowed fields and methods
+ */
class AnnotatedMixinShadowHandler extends AnnotatedMixinElementHandler {
AnnotatedMixinShadowHandler(IMixinAnnotationProcessor ap, AnnotatedMixin mixin) {
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixins.java b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixins.java
index 657dca67..443b20e9 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixins.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/AnnotatedMixins.java
@@ -75,6 +75,10 @@ class AnnotatedMixins implements IMixinAnnotationProcessor, ITokenProvider, ITyp
private static final String MAPID_SYSTEM_PROPERTY = "mixin.target.mapid";
+ /**
+ * Detected compiler argument, specifies the behaviour of some operations
+ * for compatibility purposes.
+ */
static enum CompilerEnvironment {
/**
* Default environment
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/MixinProcessor.java b/src/ap/java/org/spongepowered/tools/obfuscation/MixinProcessor.java
index 6c585c48..028eec49 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/MixinProcessor.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/MixinProcessor.java
@@ -37,6 +37,9 @@ import javax.tools.Diagnostic.Kind;
import org.spongepowered.asm.mixin.Mixin;
+/**
+ * Base class for mixin annotation processor modules
+ */
public abstract class MixinProcessor extends AbstractProcessor {
/**
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationData.java b/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationData.java
index 9f062fe2..31f4891e 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationData.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationData.java
@@ -28,6 +28,23 @@ import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
+import org.spongepowered.asm.obfuscation.SrgMethod;
+
+/**
+ * Return value struct for various obfuscation queries performed by the mixin
+ * annotation processor.
+ *
+ *
When obfuscation queries are performed by the AP, the returned data are
+ * encapsulated in an ObfuscationData object which contains a mapping
+ * of the different obfuscation types to the respective remapped value of the
+ * original entry for that environment.
+ *
+ *
The returned data are iterable over the keys, consumers should call
+ * {@link #get} to retrieve the remapped entries for each key.
+ *
+ * @param Contained type of the data, usually {@link String} for field
+ * and type obfuscations, and {@link SrgMethod} for methods.
+ */
public class ObfuscationData implements Iterable {
private final Map data = new HashMap();
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationManager.java b/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationManager.java
index 49289b58..94fcb917 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationManager.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationManager.java
@@ -43,6 +43,9 @@ import org.spongepowered.asm.util.Constants;
import org.spongepowered.tools.obfuscation.interfaces.IMixinAnnotationProcessor;
import org.spongepowered.tools.obfuscation.interfaces.IObfuscationManager;
+/**
+ * Obfuscation Manager for mixin Annotation Processor
+ */
public class ObfuscationManager implements IObfuscationManager {
/**
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationType.java b/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationType.java
index 17528c5e..679a122b 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationType.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/ObfuscationType.java
@@ -31,14 +31,43 @@ import org.spongepowered.tools.obfuscation.interfaces.IOptionProvider;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;
+/**
+ * Obfuscation types supported by the annotation processor
+ */
enum ObfuscationType {
+ /**
+ * "SEARGE" mappings, these are unique mappings used by MCP and derived
+ * projects
+ */
SRG("searge", SupportedOptions.REOBF_SRG_FILE, SupportedOptions.REOBF_EXTRA_SRG_FILES, SupportedOptions.OUT_SRG_SRG_FILE),
+
+ /**
+ * "NOTCH" mappings, internal to minecraft only
+ */
NOTCH("notch", SupportedOptions.REOBF_NOTCH_FILE, SupportedOptions.REOBF_EXTRA_NOTCH_FILES, SupportedOptions.OUT_NOTCH_SRG_FILE);
+ /**
+ * Refmap key for this mapping type
+ */
private final String key;
+
+ /**
+ * The name of the Annotation Processor argument which contains the file
+ * name to read the SRGs for this obfuscation type from
+ */
private final String srgFileArgName;
+
+ /**
+ * The name of the Annotation Processor argument which contains the file
+ * name to read the extra SRGs for this obfuscation type from
+ */
private final String extraSrgFilesArgName;
+
+ /**
+ * The name of the Annotation Processor argument which contains the file
+ * name to write generated SRG mappings to
+ */
private final String outSrgFileArgName;
private ObfuscationType(String displayName, String srgFileArgName, String extraSrgFilesArgName, String outSrgFileArgName) {
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/SupportedOptions.java b/src/ap/java/org/spongepowered/tools/obfuscation/SupportedOptions.java
index e8f2ceef..e278faf7 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/SupportedOptions.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/SupportedOptions.java
@@ -28,6 +28,10 @@ import java.util.Set;
import com.google.common.collect.ImmutableSet;
+/**
+ * Supported options for the annotation processor. Not an enum mainly so that
+ * the string tokens can be inlined.
+ */
public final class SupportedOptions {
public static final String TOKENS = "tokens";
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/TargetObfuscationEnvironment.java b/src/ap/java/org/spongepowered/tools/obfuscation/TargetObfuscationEnvironment.java
index f916003e..5d420a74 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/TargetObfuscationEnvironment.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/TargetObfuscationEnvironment.java
@@ -50,8 +50,18 @@ import org.spongepowered.asm.util.ObfuscationUtil;
import org.spongepowered.asm.util.ObfuscationUtil.IClassRemapper;
import org.spongepowered.tools.obfuscation.interfaces.IMixinAnnotationProcessor;
+/**
+ * Stores information relevant to a particular target obfuscation environment.
+ *
+ *
We classify different types of possible obfuscation (eg. "searge", "notch"
+ * ) as obfuscation environments and store related information such as
+ * the input SRG mappings, generated refmap, generated SRGs, here.
+ */
class TargetObfuscationEnvironment {
+ /**
+ * Remapping proxy for remapping descriptors
+ */
final class RemapperProxy implements IClassRemapper {
@Override
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/interfaces/IMixinValidator.java b/src/ap/java/org/spongepowered/tools/obfuscation/interfaces/IMixinValidator.java
index 9f43e6b9..3b5488df 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/interfaces/IMixinValidator.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/interfaces/IMixinValidator.java
@@ -37,6 +37,9 @@ import org.spongepowered.tools.obfuscation.TypeHandle;
*/
public interface IMixinValidator {
+ /**
+ * Validation pass
+ */
public enum ValidationPass {
EARLY,
LATE
diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/struct/Message.java b/src/ap/java/org/spongepowered/tools/obfuscation/struct/Message.java
index 4c67ce92..c18cb8fc 100644
--- a/src/ap/java/org/spongepowered/tools/obfuscation/struct/Message.java
+++ b/src/ap/java/org/spongepowered/tools/obfuscation/struct/Message.java
@@ -30,6 +30,10 @@ import javax.lang.model.element.AnnotationValue;
import javax.lang.model.element.Element;
import javax.tools.Diagnostic;
+/**
+ * Wrapper for Annotation Processor messages, used to enable messages to be
+ * easily queued and manipulated
+ */
public class Message {
private Diagnostic.Kind kind;
diff --git a/src/bridge/java/org/spongepowered/asm/bridge/RemapperAdapter.java b/src/bridge/java/org/spongepowered/asm/bridge/RemapperAdapter.java
index 5d6e9fe8..11eae88f 100644
--- a/src/bridge/java/org/spongepowered/asm/bridge/RemapperAdapter.java
+++ b/src/bridge/java/org/spongepowered/asm/bridge/RemapperAdapter.java
@@ -31,6 +31,9 @@ import org.spongepowered.asm.mixin.extensibility.IRemapper;
import org.spongepowered.asm.util.ObfuscationUtil;
import org.spongepowered.asm.util.ObfuscationUtil.IClassRemapper;
+/**
+ * Base impl of remapper
+ */
public abstract class RemapperAdapter implements IRemapper, IClassRemapper {
protected final Logger logger = LogManager.getLogger("mixin");
diff --git a/src/bridge/java/org/spongepowered/asm/bridge/RemapperAdapterFML.java b/src/bridge/java/org/spongepowered/asm/bridge/RemapperAdapterFML.java
index 165966cd..97750e1a 100644
--- a/src/bridge/java/org/spongepowered/asm/bridge/RemapperAdapterFML.java
+++ b/src/bridge/java/org/spongepowered/asm/bridge/RemapperAdapterFML.java
@@ -30,6 +30,9 @@ import java.lang.reflect.Method;
import org.objectweb.asm.commons.Remapper;
import org.spongepowered.asm.mixin.extensibility.IRemapper;
+/**
+ * Remapper adapter which remaps using FML's deobfuscating remapper
+ */
public class RemapperAdapterFML extends RemapperAdapter {
private final Method mdUnmap;
diff --git a/src/main/java/org/spongepowered/asm/launch/MixinInitialisationError.java b/src/main/java/org/spongepowered/asm/launch/MixinInitialisationError.java
index bc7ca989..8d32df36 100644
--- a/src/main/java/org/spongepowered/asm/launch/MixinInitialisationError.java
+++ b/src/main/java/org/spongepowered/asm/launch/MixinInitialisationError.java
@@ -24,6 +24,9 @@
*/
package org.spongepowered.asm.launch;
+/**
+ * Error raised when mixin subsystem initialisation fails
+ */
public class MixinInitialisationError extends Error {
private static final long serialVersionUID = 1L;
diff --git a/src/main/java/org/spongepowered/asm/mixin/MixinEnvironment.java b/src/main/java/org/spongepowered/asm/mixin/MixinEnvironment.java
index 44e09374..a15760de 100644
--- a/src/main/java/org/spongepowered/asm/mixin/MixinEnvironment.java
+++ b/src/main/java/org/spongepowered/asm/mixin/MixinEnvironment.java
@@ -545,6 +545,9 @@ public class MixinEnvironment implements ITokenProvider {
}
+ /**
+ * Temporary
+ */
static class MixinLogger {
static MixinAppender appender = new MixinAppender("MixinLogger", null, null);
@@ -555,11 +558,13 @@ public class MixinEnvironment implements ITokenProvider {
log.addAppender(appender);
}
+ /**
+ * Temporary
+ */
static class MixinAppender extends AbstractAppender {
protected MixinAppender(String name, Filter filter, Layout extends Serializable> layout) {
super(name, filter, layout);
- // TODO Auto-generated constructor stub
}
@Override
diff --git a/src/main/java/org/spongepowered/asm/mixin/MixinException.java b/src/main/java/org/spongepowered/asm/mixin/MixinException.java
index ef71da5d..059723c0 100644
--- a/src/main/java/org/spongepowered/asm/mixin/MixinException.java
+++ b/src/main/java/org/spongepowered/asm/mixin/MixinException.java
@@ -24,6 +24,9 @@
*/
package org.spongepowered.asm.mixin;
+/**
+ * Base class for all mixin processor exceptions
+ */
public class MixinException extends RuntimeException {
private static final long serialVersionUID = 1L;
diff --git a/src/main/java/org/spongepowered/asm/mixin/RemapperChain.java b/src/main/java/org/spongepowered/asm/mixin/RemapperChain.java
index 117eed0b..b0aed8c0 100644
--- a/src/main/java/org/spongepowered/asm/mixin/RemapperChain.java
+++ b/src/main/java/org/spongepowered/asm/mixin/RemapperChain.java
@@ -29,6 +29,10 @@ import java.util.List;
import org.spongepowered.asm.mixin.extensibility.IRemapper;
+/**
+ * Mixin environment remapper chain. Contains all remappers for the current
+ * environment to facilitate remapping via all registered remappers.
+ */
public class RemapperChain implements IRemapper {
private final List remappers = new ArrayList();
diff --git a/src/main/java/org/spongepowered/asm/mixin/extensibility/IMixinInfo.java b/src/main/java/org/spongepowered/asm/mixin/extensibility/IMixinInfo.java
index 696417c2..58005a42 100644
--- a/src/main/java/org/spongepowered/asm/mixin/extensibility/IMixinInfo.java
+++ b/src/main/java/org/spongepowered/asm/mixin/extensibility/IMixinInfo.java
@@ -29,6 +29,9 @@ import java.util.List;
import org.spongepowered.asm.lib.tree.ClassNode;
import org.spongepowered.asm.mixin.MixinEnvironment.Phase;
+/**
+ * Interface for MixinInfo, used in extensibility API
+ */
public interface IMixinInfo {
/**
diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/InjectionNodes.java b/src/main/java/org/spongepowered/asm/mixin/injection/InjectionNodes.java
index 53229645..96fbdb1d 100644
--- a/src/main/java/org/spongepowered/asm/mixin/injection/InjectionNodes.java
+++ b/src/main/java/org/spongepowered/asm/mixin/injection/InjectionNodes.java
@@ -29,52 +29,119 @@ import java.util.HashMap;
import java.util.Map;
import org.spongepowered.asm.lib.tree.AbstractInsnNode;
+import org.spongepowered.asm.mixin.injection.struct.Target;
import org.spongepowered.asm.util.ASMHelper;
+/**
+ * Used to keep track of instruction nodes in a {@link Target} method which are
+ * targetted by various types of injector. This collection is populated during
+ * the first injector pass and allows injectors to keep track of their targets
+ * even when the target method is being manipulated by other injectors.
+ */
public class InjectionNodes extends ArrayList {
+ /**
+ * Never gonna give you up
+ */
private static final long serialVersionUID = 1L;
+ /**
+ * A node targetted by one or more injectors. Using this wrapper allows
+ * injectors to be aware of when their target node is removed or replace by
+ * another injector. It also allows injectors to decorate certain nodes with
+ * custom metadata to allow arbitration between injectors to take place.
+ */
public static class InjectionNode implements Comparable {
+ /**
+ * The original node targetted
+ */
private final AbstractInsnNode originalTarget;
+ /**
+ * Initially set to the {@link #originalTarget}, if an injector removes
+ * or replaces this node then points to the current target. Can be null
+ * if the node is removed.
+ */
private AbstractInsnNode currentTarget;
+ /**
+ * Injector decorations on this node
+ */
private Map