From cdb973e418fad7504a7278c2d6719460e607b142 Mon Sep 17 00:00:00 2001
From: augustd <augustd@codemagi.com>
Date: Wed, 4 Nov 2020 00:28:20 -0800
Subject: [PATCH] Update javadocs

---
 src/main/java/com/codemagi/burp/Utils.java               | 2 ++
 src/main/java/com/codemagi/burp/parser/HttpRequest.java  | 2 +-
 src/main/java/com/codemagi/burp/parser/HttpResponse.java | 4 ++--
 src/main/java/com/codemagi/burp/ui/MessagePanel.java     | 2 +-
 4 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/main/java/com/codemagi/burp/Utils.java b/src/main/java/com/codemagi/burp/Utils.java
index c445bd7..82e0396 100644
--- a/src/main/java/com/codemagi/burp/Utils.java
+++ b/src/main/java/com/codemagi/burp/Utils.java
@@ -56,6 +56,8 @@ private Utils() {
     
     /**
      * Returns the human-readable tool name for the passed tool flag
+     * 
+     * @param toolFlag integer identifying the Burp tool to get the name for 
      */
     public static String getToolName(int toolFlag) {
         return noNulls(TOOLS.get(toolFlag));
diff --git a/src/main/java/com/codemagi/burp/parser/HttpRequest.java b/src/main/java/com/codemagi/burp/parser/HttpRequest.java
index 87ad4d6..64df02f 100644
--- a/src/main/java/com/codemagi/burp/parser/HttpRequest.java
+++ b/src/main/java/com/codemagi/burp/parser/HttpRequest.java
@@ -24,7 +24,7 @@
  * <p>
  * This class will parse all the header/value pairs and store them in a
  * ({@link java.util.LinkedHashMap}), and parse the first line as 'command'. The
- * <tt>LinkedHashMap</tt> will assure that an iterator will visit the fields in
+ * <code>LinkedHashMap</code> will assure that an iterator will visit the fields in
  * the order the were originally sent/parsed.
  *
  * Note that parameters sent in the body of POST requests are not parsed.
diff --git a/src/main/java/com/codemagi/burp/parser/HttpResponse.java b/src/main/java/com/codemagi/burp/parser/HttpResponse.java
index 4a679fd..66e5806 100644
--- a/src/main/java/com/codemagi/burp/parser/HttpResponse.java
+++ b/src/main/java/com/codemagi/burp/parser/HttpResponse.java
@@ -24,7 +24,7 @@
  * <p>
  * This class will parse all the header/value pairs and store them in a
  * ({@link java.util.LinkedHashMap}), and parse the first line as 'command'. The
- * <tt>LinkedHashMap</tt> will assure that an iterator will visit the fields in
+ * <code>LinkedHashMap</code> will assure that an iterator will visit the fields in
  * the order they were originally sent/parsed.
  *
  * The body of the HTTP response is stored as-is in the 'body' member.
@@ -178,7 +178,7 @@ public void addCookie(ICookie newCookie) {
     }
     
     /**
-     * Returns the _first_ cookie matching <tt>cookieName</tt>. Objects returned
+     * Returns the _first_ cookie matching <code>cookieName</code>. Objects returned
      * by this method are of the class burp.impl.Cookie which implements the
      * burp.ICookie interface.
      *
diff --git a/src/main/java/com/codemagi/burp/ui/MessagePanel.java b/src/main/java/com/codemagi/burp/ui/MessagePanel.java
index b75ebb7..68e76b8 100644
--- a/src/main/java/com/codemagi/burp/ui/MessagePanel.java
+++ b/src/main/java/com/codemagi/burp/ui/MessagePanel.java
@@ -33,7 +33,7 @@ public MessagePanel(int clearDelay) {
      * Sets the clear delay: The amount of time (in milliseconds) before
      * messages posted to the panel will be automatically cleared.
      *
-     * @param newValue
+     * @param newValue number of milliseconds for the message to persist
      */
     public void setClearDelay(int newValue) {
         clearDelay = newValue;