Fix javadoc errors under JDK8, closes #6

This commit is contained in:
Mumfrey committed 2015-01-05 01:36:55 +00:00
1 parent 589edf787a
commit 3b3a16db75
11 files changed
+38 -27

No files matched your search

@@ -56,7 +56,7 @@ public @interface Shadow {
* </pre></blockquote>
*
* <p>All of these declarations are semantically equivalent, however the third and fourth are the most expressive in terms of making their
* intentions clear, and thus specifying prefix is recommended, since it aids readability and maintainability.<p>
* intentions clear, and thus specifying prefix is recommended, since it aids readability and maintainability.</p>
*
* <p>Note that specifying a <em>prefix</em> does not <b>enforce</b> use of the prefix, the behaviour of <em>prefix</em> is such that the prefix
* will be stripped from the start of the method name <em>as long as the method name actually starts with the prefix</em>! This has important
@@ -82,7 +82,9 @@ public @interface At {
/**
* Target member used by INVOKE, INVOKE_STRING and FIELD. This <b>must be specified as a fully-qualified member path</b> including the class name
* and signature. Failing to fully-qualify the target member will result in an error at obfuscation time.
* and signature. Failing to fully-qualify the target member will result in an error at obfuscation time.
*
* @return target reference for supported InjectionPoint types
*/
public String target() default "";
@@ -90,7 +92,9 @@ public @interface At {
* Ordinal offset. Many InjectionPoints will return every opcode matching their criteria, specifying <em>ordinal</em> allows a particular opcode
* to be identified from the returned list. The default value of -1 does not alter the behaviour and returns all matching opcodes. Specifying a
* value of 0 or higher returns <em>only</em> the requested opcode (if one exists: for example specifying an ordinal of 4 when only 2 opcodes are
* matched by the InjectionPoint is not going to work particularly well!)
* matched by the InjectionPoint is not going to work particularly well!)
*
* @return ordinal value for supported InjectionPoint types
*/
public int ordinal() default -1;
@@ -31,7 +31,7 @@ import org.spongepowered.asm.mixin.injection.struct.InjectionPointData;
/**
* <p>This injection point searches for GETFIELD and PUTFIELD (and static equivalent) opcodes matching its arguments and returns a list of insns
* immediately prior to matching instructions. It accepts the following parameters from {@link org.spongepowered.asm.mixin.injection.At At}:<p>
* immediately prior to matching instructions. It accepts the following parameters from {@link org.spongepowered.asm.mixin.injection.At At}:</p>
*
* <dl>
* <dt>target</dt>
@@ -43,9 +43,10 @@ import org.spongepowered.asm.mixin.injection.struct.InjectionPointData;
* specify an <em>ordinal</em> of <b>2</b> (ordinals are zero-indexed). The default value is <b>-1</b> which supresses ordinal matching</dd>
* </dl>
*
* <p>Example:<blockquote><pre>
* <p>Example:</p>
* <blockquote><pre>
* &#064;At(value = "FIELD", target="field_5678_z:I", opcode = Opcodes.GETFIELD)</pre>
* </blockquote></p>
* </blockquote>
*
* <p>Note that like all standard injection points, this class matches the insn itself, putting the injection point immediately <em>before</em> the
* access in question. Use the {@link org.spongepowered.asm.mixin.injection.At#shift shift} specifier to adjust the matched opcode as necessary.</p>
@@ -38,7 +38,7 @@ import org.spongepowered.asm.mixin.injection.struct.MemberInfo;
/**
* <p>This injection point searches for INVOKEVIRTUAL, INVOKESTATIC and INVOKESPECIAL opcodes matching its arguments and returns a list of insns
* immediately prior to matching instructions. It accepts the following parameters from {@link org.spongepowered.asm.mixin.injection.At At}:<p>
* immediately prior to matching instructions. It accepts the following parameters from {@link org.spongepowered.asm.mixin.injection.At At}:</p>
*
* <dl>
* <dt>target</dt>
@@ -48,9 +48,10 @@ import org.spongepowered.asm.mixin.injection.struct.MemberInfo;
* can specify an <em>ordinal</em> of <b>2</b> (ordinals are zero-indexed). The default value is <b>-1</b> which supresses ordinal matching</dd>
* </dl>
*
* <p>Example:<blockquote><pre>
* <p>Example:</p>
* <blockquote><pre>
* &#064;At(value = "INVOKE", target="func_1234_a(III)V")</pre>
* </blockquote></p>
* </blockquote>
*
* <p>Note that like all standard injection points, this class matches the insn itself, putting the injection point immediately <em>before</em> the
* access in question. Use the {@link org.spongepowered.asm.mixin.injection.At#shift shift} specifier to adjust the matched opcode as necessary.</p>
@@ -36,7 +36,7 @@ import org.spongepowered.asm.mixin.injection.struct.InjectionPointData;
/**
* <p>This injection point searches for NEW opcodes matching its arguments and returns a list of insns immediately prior to matching instructions. It
* accepts the following parameters from {@link org.spongepowered.asm.mixin.injection.At At}:<p>
* accepts the following parameters from {@link org.spongepowered.asm.mixin.injection.At At}:</p>
*
* <dl>
* <dt><em>named argument</em> class</dt>
@@ -47,9 +47,10 @@ import org.spongepowered.asm.mixin.injection.struct.InjectionPointData;
* matching</dd>
* </dl>
*
* <p>Example:<blockquote><pre>
* <p>Example:</p>
* <blockquote><pre>
* &#064;At(value = "NEW", args = { "class=java/lang/String" })</pre>
* </blockquote></p>
* </blockquote>
*
* <p>Note that like all standard injection points, this class matches the insn itself, putting the injection point immediately <em>before</em> the
* access in question. Use the {@link org.spongepowered.asm.mixin.injection.At#shift shift} specifier to adjust the matched opcode as necessary.</p>
@@ -48,13 +48,14 @@ import org.spongepowered.asm.mixin.injection.struct.InjectionPointData;
* (ordinals are zero-indexed). The default value is <b>-1</b> which supresses ordinal matching</dd>
* </dl>
*
* <p>Example:<blockquote><pre>
* <p>Example:</p>
* <blockquote><pre>
* &#064;At(value = "RETURN")</pre>
* </blockquote>
* Note that if <em>value</em> is the only parameter specified, it can be omitted:
* <p>Note that if <em>value</em> is the only parameter specified, it can be omitted:</p>
* <blockquote><pre>
* &#064;At("RETURN")</pre>
* </blockquote></p>
* </blockquote>
*/
public class BeforeReturn extends InjectionPoint {
@@ -55,10 +55,11 @@ import org.spongepowered.asm.mixin.injection.struct.MemberInfo;
* <dd>The value of the LDC node to look for prior to the method invocation</dd>
* </dl>
*
* <p>Example:<blockquote><pre>
* <p>Example:</p>
* <blockquote><pre>
* &#064;At(value = "INVOKE_STRING", target="startSection(Ljava/lang/String;)V", args = { "ldc=root" })</pre>
* </blockquote>
* Notice the use of the <em>named argument</em> "ldc" which specifies the value of the target LDC node.</p>
* <p>Notice the use of the <em>named argument</em> "ldc" which specifies the value of the target LDC node.</p>
*
* <p>Note that like all standard injection points, this class matches the insn itself, putting the injection point immediately <em>before</em> the
* access in question. Use the {@link org.spongepowered.asm.mixin.injection.At#shift shift} specifier to adjust the matched opcode as necessary.</p>
@@ -37,7 +37,7 @@ import org.spongepowered.asm.mixin.injection.struct.InjectionPointData;
/**
* <p>This injection point searches for JUMP opcodes (if, try/catch, continue, break, conditional assignment, etc.) with either a particular opcode
* or at a particular ordinal in the method body (eg. "the Nth JUMP insn" where N is the ordinal of the instruction). By default it returns all JUMP
* instructions in a method body. It accepts the following parameters from {@link org.spongepowered.asm.mixin.injection.At At}:<p>
* instructions in a method body. It accepts the following parameters from {@link org.spongepowered.asm.mixin.injection.At At}:</p>
*
* <dl>
* <dt>opcode</dt>
@@ -49,9 +49,10 @@ import org.spongepowered.asm.mixin.injection.struct.InjectionPointData;
* can specify an <em>ordinal</em> of <b>1</b> (ordinals are zero-indexed). The default value is <b>-1</b> which supresses ordinal matching</dd>
* </dl>
*
* <p>Example:<blockquote><pre>
* <p>Example:</p>
* <blockquote><pre>
* &#064;At(value = "JUMP", opcode = Opcodes.IFLE, ordinal = 2)</pre>
* </blockquote></p>
* </blockquote>
*
* <p>Note that like all standard injection points, this class matches the insn itself, putting the injection point immediately <em>before</em> the
* access in question. Use the {@link org.spongepowered.asm.mixin.injection.At#shift shift} specifier to adjust the matched opcode as necessary.</p>
@@ -35,9 +35,10 @@ import org.spongepowered.asm.mixin.injection.struct.InjectionPointData;
* <p>This injection point simply returns the first instruction in the target method body, allowing the injection to be placed at the "head" of the
* target method. It accepts no parameters and only returns a single insn in all circumstances.</p>
*
* <p>Example:<blockquote><pre>
* <p>Example:</p>
* <blockquote><pre>
* &#064;At("HEAD")</pre>
* </blockquote></p>
* </blockquote>
*/
public class MethodHead extends InjectionPoint {
@@ -36,7 +36,8 @@ import org.spongepowered.asm.mixin.transformer.MixinData;
* <p>Information bundle about a member (method or field) parsed from a String token in another annotation, this is used where target members need to
* be specified as Strings in order to parse the String representation to something useful.</p>
*
* <p>Some examples: <blockquote><pre>
* <p>Some examples:</p>
* <blockquote><pre>
* // references a method or field called func_1234_a, if there are multiple members with the same signature, matches the first occurrence
* func_1234_a
*
@@ -50,7 +51,7 @@ import org.spongepowered.asm.mixin.transformer.MixinData;
* field_5678_z:Ljava/lang/String;
*
* // references a ctor which takes a single String argument
* <init>(Ljava/lang/String;)V
* &lt;init&gt;(Ljava/lang/String;)V
*
* // references a method called func_1234_a in class foo.bar.Baz
* Lfoo/bar/Baz;func_1234_a
@@ -62,8 +63,8 @@ import org.spongepowered.asm.mixin.transformer.MixinData;
* Lfoo/bar/Baz;func_1234_a(DDD)V
*
* // alternate syntax for the same
* foo.bar.Baz.func_1234_a(DDD)V</pre></blockquote>
* </p>
* foo.bar.Baz.func_1234_a(DDD)V</pre>
* </blockquote>
*/
public class MemberInfo {
@@ -491,7 +491,6 @@ public class ASMHelper {
* @param enumClass Class of enum containing the enum constant to search for
* @param defaultValue Value to return if the specified key isn't found
* @return duck-typed annotation value or defaultValue if missing
* @throws NoSuchFieldException
*/
public static <T extends Enum<T>> T getAnnotationValue(AnnotationNode annotationNode, String key, Class<T> enumClass, T defaultValue) {
String[] value = ASMHelper.<String[]>getAnnotationValue(annotationNode, key);