Fix various warnings produced by "./gradlew javadoc"

Three stubborn warnings remain, but this is progress!
This commit is contained in:
Ben Liblit 2018-01-29 13:07:41 -06:00
parent 72a9ddd2d7
commit 62d7980ea3
8 changed files with 29 additions and 15 deletions

View File

@ -13,3 +13,11 @@ dependencies {
project(':com.ibm.wala.util'), project(':com.ibm.wala.util'),
) )
} }
javadoc {
def rhino = project(':com.ibm.wala.cast.js.rhino').compileJava
dependsOn rhino
doFirst {
classpath += files rhino
}
}

View File

@ -104,7 +104,7 @@ import com.ibm.wala.util.strings.Atom;
* {@link JSImplicitPointsToSetVisitor#visitAstGlobalRead(AstGlobalRead)}. * {@link JSImplicitPointsToSetVisitor#visitAstGlobalRead(AstGlobalRead)}.
* Finally, we need to represent direct flow of the global object to handle * Finally, we need to represent direct flow of the global object to handle
* receiver argument semantics (see * receiver argument semantics (see
* {@link org.mozilla.javascript.RhinoToAstTranslator}). To do so, we create a * {@link com.ibm.wala.cast.js.translator.RhinoToAstTranslator}). To do so, we create a
* reference to a global named {@link #GLOBAL_OBJ_VAR_NAME}, which is handled * reference to a global named {@link #GLOBAL_OBJ_VAR_NAME}, which is handled
* specially in {@link JSConstraintVisitor#visitAstGlobalRead(AstGlobalRead)}. * specially in {@link JSConstraintVisitor#visitAstGlobalRead(AstGlobalRead)}.
*/ */

View File

@ -15,11 +15,17 @@ dependencies {
} }
javadoc { javadoc {
dependsOn ':com.ibm.wala.cast.js:compileJava' def js = ':com.ibm.wala.cast.js'
dependsOn "$js:compileJava"
doFirst { doFirst {
classpath += files(project(':com.ibm.wala.cast.js').compileJava) classpath += files project(js).compileJava
} }
/*
// creates circular dependency
def jsDoc = project(js).javadoc
dependsOn jsDoc
options.links jsDoc.outputDirectory.path
*/
} }
def currentJavaHome = org.gradle.internal.jvm.Jvm.current().javaHome def currentJavaHome = org.gradle.internal.jvm.Jvm.current().javaHome

View File

@ -18,9 +18,10 @@ dependencies {
} }
javadoc { javadoc {
dependsOn ':com.ibm.wala.dalvik:compileJava' def dalvik = ':com.ibm.wala.dalvik'
dependsOn "$dalvik:compileJava"
doFirst { doFirst {
classpath += files(project(':com.ibm.wala.dalvik').compileJava) classpath += files project(dalvik).compileJava
} }
} }

View File

@ -52,7 +52,6 @@ import com.ibm.wala.classLoader.NewSiteReference;
import com.ibm.wala.ipa.cha.IClassHierarchy; import com.ibm.wala.ipa.cha.IClassHierarchy;
import com.ibm.wala.shrikeBT.IConditionalBranchInstruction; import com.ibm.wala.shrikeBT.IConditionalBranchInstruction;
import com.ibm.wala.shrikeBT.IInvokeInstruction; import com.ibm.wala.shrikeBT.IInvokeInstruction;
import com.ibm.wala.shrikeCT.BootstrapMethodsReader.BootstrapMethod;
import com.ibm.wala.ssa.SSAAbstractInvokeInstruction; import com.ibm.wala.ssa.SSAAbstractInvokeInstruction;
import com.ibm.wala.ssa.SSAArrayLoadInstruction; import com.ibm.wala.ssa.SSAArrayLoadInstruction;
import com.ibm.wala.ssa.SSAArrayStoreInstruction; import com.ibm.wala.ssa.SSAArrayStoreInstruction;
@ -102,7 +101,7 @@ public class TypeSafeInstructionFactory {
* *
* Calls result.setAssigned() * Calls result.setAssigned()
* *
* @see com.ibm.wala.classLoader.JavaLanguage.JavaInstructionFactory#InvokeInstruction(int, int, int[], int, CallSiteReference, BootstrapMethod) * @see com.ibm.wala.classLoader.JavaLanguage.JavaInstructionFactory#InvokeInstruction(int, int, int[], int, CallSiteReference, com.ibm.wala.shrikeCT.BootstrapMethodsReader.BootstrapMethod)
* *
* @param iindex Zero or a positive number unique to any instruction of the same method * @param iindex Zero or a positive number unique to any instruction of the same method
* @param result Where to place the return-value of the called method. Is SSAValue.setAssigned() automatically. * @param result Where to place the return-value of the called method. Is SSAValue.setAssigned() automatically.
@ -215,7 +214,7 @@ public class TypeSafeInstructionFactory {
* All parameters (but exception) are typechecked first. If the check passes they get unpacked and handed over * All parameters (but exception) are typechecked first. If the check passes they get unpacked and handed over
* to the corresponding JavaInstructionFactory.InvokeInstruction. * to the corresponding JavaInstructionFactory.InvokeInstruction.
* *
* @see com.ibm.wala.classLoader.JavaLanguage.JavaInstructionFactory#InvokeInstruction(int, int[], int, CallSiteReference, BootstrapMethod) * @see com.ibm.wala.classLoader.JavaLanguage.JavaInstructionFactory#InvokeInstruction(int, int[], int, CallSiteReference, com.ibm.wala.shrikeCT.BootstrapMethodsReader.BootstrapMethod)
* *
* @param iindex Zero or a positive number unique to any instruction of the same method * @param iindex Zero or a positive number unique to any instruction of the same method
* @param params Parameters to the call starting with the implicit this-pointer if necessary * @param params Parameters to the call starting with the implicit this-pointer if necessary

View File

@ -159,7 +159,7 @@ public abstract class AbstractAndroidModel {
* *
* This function is expected to be called on entrypoints in ascending order. * This function is expected to be called on entrypoints in ascending order.
* *
* You are expected to call {@link #enter(ExecutionOrder, int)} iff a * You are expected to call {@link #enter(com.ibm.wala.dalvik.ipa.callgraph.impl.AndroidEntryPoint.ExecutionOrder, int)} iff a
* Label got skipped over. * Label got skipped over.
* *
* @param order The entrypoint in question * @param order The entrypoint in question

View File

@ -214,7 +214,7 @@ public class AndroidEntryPoint extends DexEntryPoint {
* Unrecommended way to generate the Order based on an Integer. * Unrecommended way to generate the Order based on an Integer.
* *
* This method is handy when reading back files. In your code you should prefer the methods * This method is handy when reading back files. In your code you should prefer the methods
* {@link #after(IExecutionOrder)} and {@link #between(IExecutionOrder, IExecutionOrder)}. * {@link #after(com.ibm.wala.dalvik.ipa.callgraph.impl.AndroidEntryPoint.IExecutionOrder)} and {@link #between(com.ibm.wala.dalvik.ipa.callgraph.impl.AndroidEntryPoint.IExecutionOrder, com.ibm.wala.dalvik.ipa.callgraph.impl.AndroidEntryPoint.IExecutionOrder)}.
*/ */
public ExecutionOrder(int val) { public ExecutionOrder(int val) {
this.value=val; this.value=val;
@ -264,7 +264,7 @@ public class AndroidEntryPoint extends DexEntryPoint {
* Use this to place a call to an EntryPoint between two other EntryPoint calls or ExecutionOrder "labels". * Use this to place a call to an EntryPoint between two other EntryPoint calls or ExecutionOrder "labels".
* between() does not care about section-boundaries by itself! * between() does not care about section-boundaries by itself!
* *
* Use {@link #between(IExecutionOrder[], IExecutionOrder[])} and use labels as additional placement-information * Use {@link #between(com.ibm.wala.dalvik.ipa.callgraph.impl.AndroidEntryPoint.IExecutionOrder[], com.ibm.wala.dalvik.ipa.callgraph.impl.AndroidEntryPoint.IExecutionOrder[])} and use labels as additional placement-information
* to prevent unexpected misplacement. * to prevent unexpected misplacement.
* *
* @param after the call or "label" to be executed before this one * @param after the call or "label" to be executed before this one
@ -299,7 +299,7 @@ public class AndroidEntryPoint extends DexEntryPoint {
* This method is intended to be more robust when changing the position-information of referred-to * This method is intended to be more robust when changing the position-information of referred-to
* ExecutionOrders. * ExecutionOrders.
* *
* In any other means it behaves exactly like {@link #between(IExecutionOrder, IExecutionOrder)}. * In any other means it behaves exactly like {@link #between(com.ibm.wala.dalvik.ipa.callgraph.impl.AndroidEntryPoint.IExecutionOrder, com.ibm.wala.dalvik.ipa.callgraph.impl.AndroidEntryPoint.IExecutionOrder)}.
* *
* @param after the calls or "labels" to be executed before this one * @param after the calls or "labels" to be executed before this one
* @param before the calls or "labels" to be executed after this one (inclusive) * @param before the calls or "labels" to be executed after this one (inclusive)
@ -359,7 +359,7 @@ public class AndroidEntryPoint extends DexEntryPoint {
} }
/** /**
* Prefer {@link #after(IExecutionOrder)} whenever possible. * Prefer {@link #after(com.ibm.wala.dalvik.ipa.callgraph.impl.AndroidEntryPoint.IExecutionOrder)} whenever possible.
*/ */
public static ExecutionOrder after (int after) { public static ExecutionOrder after (int after) {
return between(after, ((after / (Integer.MAX_VALUE / 8)) + 1) * (Integer.MAX_VALUE / 8)); return between(after, ((after / (Integer.MAX_VALUE / 8)) + 1) * (Integer.MAX_VALUE / 8));

View File

@ -8,7 +8,7 @@ javadoc {
def coreCompileJava = project(':com.ibm.wala.core').compileJava def coreCompileJava = project(':com.ibm.wala.core').compileJava
dependsOn coreCompileJava dependsOn coreCompileJava
doFirst { doFirst {
classpath += files(coreCompileJava) classpath += files coreCompileJava
} }
options.links 'https://docs.oracle.com/javase/8/docs/api/' options.links 'https://docs.oracle.com/javase/8/docs/api/'
} }