From 026d353fc7b1c4392d2c5f64e8d29dbb795e7d34 Mon Sep 17 00:00:00 2001
From: Ben Gruver <bgruv@google.com>
Date: Sun, 28 Dec 2014 14:14:19 -0800
Subject: [PATCH] Fix some javadoc issues

---
 .../main/java/org/jf/dexlib2/dexbacked/BaseDexReader.java    | 1 -
 .../src/main/java/org/jf/dexlib2/iface/debug/DebugItem.java  | 3 +--
 .../src/main/java/org/jf/dexlib2/util/AnnotatedBytes.java    | 3 +--
 brut.apktool.smali/util/src/main/java/ds/tree/RadixTree.java | 2 +-
 .../util/src/main/java/ds/tree/RadixTreeImpl.java            | 2 +-
 brut.apktool.smali/util/src/main/java/ds/tree/Visitor.java   | 3 ++-
 .../util/src/main/java/ds/tree/VisitorImpl.java              | 5 +++--
 .../util/src/main/java/org/jf/util/ConsoleUtil.java          | 2 +-
 8 files changed, 10 insertions(+), 11 deletions(-)

diff --git a/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/dexbacked/BaseDexReader.java b/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/dexbacked/BaseDexReader.java
index 262fb546..96645b8c 100644
--- a/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/dexbacked/BaseDexReader.java
+++ b/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/dexbacked/BaseDexReader.java
@@ -48,7 +48,6 @@ public class BaseDexReader<T extends BaseDexBuffer> {
     public int getOffset() { return offset; }
     public void setOffset(int offset) { this.offset = offset; }
 
-    /** {@inheritDoc} */
     public int readSleb128() {
         int end = offset;
         int currentByteValue;
diff --git a/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/iface/debug/DebugItem.java b/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/iface/debug/DebugItem.java
index ea3f5ffb..6cf4dbbc 100644
--- a/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/iface/debug/DebugItem.java
+++ b/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/iface/debug/DebugItem.java
@@ -48,8 +48,7 @@ public interface DebugItem {
     int getDebugItemType();
 
     /**
-     * The code address
-     * @return
+     * @return The code address
      */
     int getCodeAddress();
 }
diff --git a/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/util/AnnotatedBytes.java b/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/util/AnnotatedBytes.java
index c48bac2d..5b4e3ee8 100644
--- a/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/util/AnnotatedBytes.java
+++ b/brut.apktool.smali/dexlib2/src/main/java/org/jf/dexlib2/util/AnnotatedBytes.java
@@ -268,8 +268,7 @@ public class AnnotatedBytes {
     }
 
     /**
-     * Gets the width of the right side containing the annotations
-     * @return
+     * @return The width of the right side containing the annotations
      */
     public int getAnnotationWidth() {
         int leftWidth = 8 + (hexCols * 2) + (hexCols / 2);
diff --git a/brut.apktool.smali/util/src/main/java/ds/tree/RadixTree.java b/brut.apktool.smali/util/src/main/java/ds/tree/RadixTree.java
index bf05e9d9..7055e049 100644
--- a/brut.apktool.smali/util/src/main/java/ds/tree/RadixTree.java
+++ b/brut.apktool.smali/util/src/main/java/ds/tree/RadixTree.java
@@ -57,7 +57,7 @@ public interface RadixTree<T> {
     /**
      * Delete a key and its associated value from the tree.
      * @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);
 
diff --git a/brut.apktool.smali/util/src/main/java/ds/tree/RadixTreeImpl.java b/brut.apktool.smali/util/src/main/java/ds/tree/RadixTreeImpl.java
index 58797d48..017ea877 100644
--- a/brut.apktool.smali/util/src/main/java/ds/tree/RadixTreeImpl.java
+++ b/brut.apktool.smali/util/src/main/java/ds/tree/RadixTreeImpl.java
@@ -373,7 +373,7 @@ public class RadixTreeImpl<T> implements RadixTree<T>, Formattable {
      * Display the Trie on console.
      *
      * WARNING! Do not use this for a large Trie, it's for testing purpose only.
-     * @see formatTo
+     * @see #formatTo
      */
     @Deprecated
     public void display() {
diff --git a/brut.apktool.smali/util/src/main/java/ds/tree/Visitor.java b/brut.apktool.smali/util/src/main/java/ds/tree/Visitor.java
index 816e08b0..34b8d651 100644
--- a/brut.apktool.smali/util/src/main/java/ds/tree/Visitor.java
+++ b/brut.apktool.smali/util/src/main/java/ds/tree/Visitor.java
@@ -33,7 +33,8 @@ package ds.tree;
  * @author Tahseen Ur Rehman (tahseen.ur.rehman {at.spam.me.not} gmail.com)
  * @author Javid Jamae
  * @author Dennis Heidsiek
- * @param <T,R>
+ * @param <T>
+ * @param <R>
  */
 public interface Visitor<T, R> {
     /**
diff --git a/brut.apktool.smali/util/src/main/java/ds/tree/VisitorImpl.java b/brut.apktool.smali/util/src/main/java/ds/tree/VisitorImpl.java
index ff4e8d17..4670ad33 100644
--- a/brut.apktool.smali/util/src/main/java/ds/tree/VisitorImpl.java
+++ b/brut.apktool.smali/util/src/main/java/ds/tree/VisitorImpl.java
@@ -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
- * @param <T,R>
+ * @param <T>
+ * @param <R>
  */
 public abstract class VisitorImpl<T, R> implements Visitor<T, R> {
 
diff --git a/brut.apktool.smali/util/src/main/java/org/jf/util/ConsoleUtil.java b/brut.apktool.smali/util/src/main/java/org/jf/util/ConsoleUtil.java
index 4d1e030f..21e5567d 100644
--- a/brut.apktool.smali/util/src/main/java/org/jf/util/ConsoleUtil.java
+++ b/brut.apktool.smali/util/src/main/java/org/jf/util/ConsoleUtil.java
@@ -35,7 +35,7 @@ import java.util.regex.Pattern;
 public class ConsoleUtil {
     /**
      * 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() {
         if (System.getProperty("os.name").toLowerCase().contains("windows")) {