"@returns" is not a valid Javadoc tag, but "@return" is

This commit is contained in:
Ben Liblit 2017-12-19 14:21:29 -06:00
parent ce403cef2b
commit d8b041469f
4 changed files with 8 additions and 8 deletions

View File

@ -26,7 +26,7 @@ public interface ILiveObjectAnalysis {
* @param m method in question
* @param instructionIndex index of an instruction in SSA IR. in m. if -1, it is interpreted as a wildcard meaning "any statement"
* @throws WalaException
* @returns true if an object allocated at the allocation site <allocMethod,allocPC> may be live immediately after the
* @return true if an object allocated at the allocation site <allocMethod,allocPC> may be live immediately after the
* statement <m,instructionIndex>
*/
public boolean mayBeLive(CGNode allocMethod, int allocPC, CGNode m, int instructionIndex) throws WalaException;
@ -36,7 +36,7 @@ public interface ILiveObjectAnalysis {
* @param m method in question
* @param instructionIndex index of an instruction in SSA IR. in m. if -1, it is interpreted as a wildcard meaning "any statement"
* @throws WalaException
* @returns true if an object allocated at the allocation site <allocMethod,allocPC> may be live immediately after the
* @return true if an object allocated at the allocation site <allocMethod,allocPC> may be live immediately after the
* statement <m,instructionIndex>
*/
public boolean mayBeLive(InstanceKey ik, CGNode m, int instructionIndex) throws WalaException;
@ -45,7 +45,7 @@ public interface ILiveObjectAnalysis {
* @param ik an instance key
* @param m method in question
* @param instructionIndices indices of instructions in SSA IR.
* @returns true if an object allocated at the allocation site <allocMethod,allocPC> may be live immediately after the
* @return true if an object allocated at the allocation site <allocMethod,allocPC> may be live immediately after the
* statement <m,instructionIndex> for any instructionIndex in the set
*/
public boolean mayBeLive(InstanceKey ik, CGNode m, IntSet instructionIndices);

View File

@ -22,7 +22,7 @@ public interface IMethodEscapeAnalysis {
* @param allocMethod a method which holds an allocation site
* @param allocPC bytecode index of allocation site
* @param m method in question
* @returns true if an object allocated at the allocation site <allocMethod,allocPC> may escape from an activation of method m,
* @return true if an object allocated at the allocation site <allocMethod,allocPC> may escape from an activation of method m,
* false otherwise
*/
public boolean mayEscape(MethodReference allocMethod, int allocPC, MethodReference m) throws WalaException;

View File

@ -23,7 +23,7 @@ public interface INodeEscapeAnalysis extends IMethodEscapeAnalysis {
* @param allocPC bytecode index of allocation site
* @param node method in question
* @throws WalaException
* @returns true if an object allocated at the allocation site <allocMethod,allocPC> may escape from an activation of node m,
* @return true if an object allocated at the allocation site <allocMethod,allocPC> may escape from an activation of node m,
* false otherwise
*/
public boolean mayEscape(CGNode allocNode, int allocPC, CGNode node) throws WalaException;

View File

@ -51,7 +51,7 @@ public abstract class UTF8Convert {
*
* @param utf8 (pseudo-)utf8 byte array
* @throws UTFDataFormatException if the (pseudo-)utf8 byte array is not valid (pseudo-)utf8
* @returns unicode string
* @return unicode string
* @throws IllegalArgumentException if utf8 is null
*/
@SuppressWarnings("unused")
@ -112,7 +112,7 @@ public abstract class UTF8Convert {
* The output format is controlled by the WRITE_PSEUDO_UTF8 flag.
*
* @param s String to convert
* @returns array containing sequence of (pseudo-)utf8 formatted bytes
* @return array containing sequence of (pseudo-)utf8 formatted bytes
* @throws IllegalArgumentException if s is null
*/
public static byte[] toUTF8(String s) {
@ -165,7 +165,7 @@ public abstract class UTF8Convert {
* Check whether the given sequence of bytes is valid (pseudo-)utf8.
*
* @param bytes byte array to check
* @returns true iff the given sequence is valid (pseudo-)utf8.
* @return true iff the given sequence is valid (pseudo-)utf8.
* @throws IllegalArgumentException if bytes is null
*/
public static boolean check(byte[] bytes) {