Fix some javadoc issues

This commit is contained in:
Ben Gruver 2014-12-28 14:14:19 -08:00 committed by Connor Tumbleson
parent 0153548c30
commit 026d353fc7
8 changed files with 10 additions and 11 deletions

View File

@ -48,7 +48,6 @@ public class BaseDexReader<T extends BaseDexBuffer> {
public int getOffset() { return offset; } public int getOffset() { return offset; }
public void setOffset(int offset) { this.offset = offset; } public void setOffset(int offset) { this.offset = offset; }
/** {@inheritDoc} */
public int readSleb128() { public int readSleb128() {
int end = offset; int end = offset;
int currentByteValue; int currentByteValue;

View File

@ -48,8 +48,7 @@ public interface DebugItem {
int getDebugItemType(); int getDebugItemType();
/** /**
* The code address * @return The code address
* @return
*/ */
int getCodeAddress(); int getCodeAddress();
} }

View File

@ -268,8 +268,7 @@ public class AnnotatedBytes {
} }
/** /**
* Gets the width of the right side containing the annotations * @return The width of the right side containing the annotations
* @return
*/ */
public int getAnnotationWidth() { public int getAnnotationWidth() {
int leftWidth = 8 + (hexCols * 2) + (hexCols / 2); int leftWidth = 8 + (hexCols * 2) + (hexCols / 2);

View File

@ -57,7 +57,7 @@ public interface RadixTree<T> {
/** /**
* Delete a key and its associated value from the tree. * Delete a key and its associated value from the tree.
* @param key The key of the node that need to be deleted * @param key The key of the node that need to be deleted
* @return * @return True if the key was deleted, false if not found
*/ */
public boolean delete(String key); public boolean delete(String key);

View File

@ -373,7 +373,7 @@ public class RadixTreeImpl<T> implements RadixTree<T>, Formattable {
* Display the Trie on console. * Display the Trie on console.
* *
* WARNING! Do not use this for a large Trie, it's for testing purpose only. * WARNING! Do not use this for a large Trie, it's for testing purpose only.
* @see formatTo * @see #formatTo
*/ */
@Deprecated @Deprecated
public void display() { public void display() {

View File

@ -33,7 +33,8 @@ package ds.tree;
* @author Tahseen Ur Rehman (tahseen.ur.rehman {at.spam.me.not} gmail.com) * @author Tahseen Ur Rehman (tahseen.ur.rehman {at.spam.me.not} gmail.com)
* @author Javid Jamae * @author Javid Jamae
* @author Dennis Heidsiek * @author Dennis Heidsiek
* @param <T,R> * @param <T>
* @param <R>
*/ */
public interface Visitor<T, R> { public interface Visitor<T, R> {
/** /**

View File

@ -2,10 +2,11 @@ package ds.tree;
/** /**
* A simple standard implementation for a {@link visitor}. * A simple standard implementation for a {@link Visitor}.
* *
* @author Dennis Heidsiek * @author Dennis Heidsiek
* @param <T,R> * @param <T>
* @param <R>
*/ */
public abstract class VisitorImpl<T, R> implements Visitor<T, R> { public abstract class VisitorImpl<T, R> implements Visitor<T, R> {

View File

@ -35,7 +35,7 @@ import java.util.regex.Pattern;
public class ConsoleUtil { public class ConsoleUtil {
/** /**
* Attempt to find the width of the console. If it can't get the width, return a default of 80 * Attempt to find the width of the console. If it can't get the width, return a default of 80
* @return * @return The current console width
*/ */
public static int getConsoleWidth() { public static int getConsoleWidth() {
if (System.getProperty("os.name").toLowerCase().contains("windows")) { if (System.getProperty("os.name").toLowerCase().contains("windows")) {