yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-06 03:50:02 +02:00
Code Issues Releases Wiki Activity

javadoc html5

Browse source
This commit is contained in:
astrelsky 2019-12-12 22:47:09 -05:00
parent 3eb130123b
commit 3bdf049d44
No known key found for this signature in database
GPG key ID: FA88FA97D6877C37
136 changed files with 428 additions and 425 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Ghidra/Framework/Generic/src/main/java/generic/cache/CountingBasicFactory.java vendored
View file

@ -41,8 +41,8 @@ public abstract class CountingBasicFactory<T> implements BasicFactory<T> {
* The method subclass use to create {@link T}s.
*
* @param itemNumber the number of the item being created--
* <font size="5"><b>one-based</b></font>; the first item
* is item <tt>1</tt>.
* <span style="font-size:24px"><b>one-based</b></span>; the first item
* is item <code>1</code>.
* @return a new instance of {@link T}.
* @throws Exception any Exception encountered during creation
*/

34
Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java
View file

@ -53,23 +53,23 @@ import ghidra.util.task.TaskMonitor;
* <hr>
* <p>
* <u>Put Items and Handle Results in Any Order as They Available:</u>
* <pre>{@literal
* QCallback<ITEM, RESULT> callback = new AbstractQCallback<ITEM, RESULT>() {
* <pre>
* {@literal QCallback<ITEM, RESULT> callback = new AbstractQCallback<ITEM, RESULT>()} {
* public RESULT process(ITEM item, TaskMonitor monitor) {
* // do work here...
* }
* };
*
* QItemListener<ITEM, RESULT> itemListener = new QItemListener<ITEM, RESULT>() {
* public void itemProcessed(QResult<ITEM, RESULT> result) {
* RESULT result = result.getResult();}
* <font color="blue"><b>// work on my result...</b></font>{@code
* {@literal QItemListener<ITEM, RESULT> itemListener = new QItemListener<ITEM, RESULT>()} {
* {@literal public void itemProcessed(QResult<ITEM, RESULT> result)} {
* RESULT result = result.getResult();
* <span style="color:blue"><b>// work on my result...</b></span>
* }
* };
*
* ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>();
* {@literal ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>();
* builder.setThreadPoolName("Thread Pool Name");
* }<font color="blue"><b>builder.setListener(itemListener);</b></font>{@code
* }<span style="color:blue"><b>builder.setListener(itemListener);</b></span>
* concurrentQ = builder.build(callback);
* ...
* ...
@ -77,7 +77,7 @@ import ghidra.util.task.TaskMonitor;
* concurrentQ.add(item);
* concurrentQ.add(item);
*
* }</pre>
* </pre>
*
* <hr>
* <p>
@ -91,7 +91,7 @@ import ghidra.util.task.TaskMonitor;
*
* ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>();
* builder.setThreadPoolName("Thread Pool Name");
* }<font color="blue"><b>builder.setCollectResults(true);</b></font>{@code
* }<span style="color:blue"><b>builder.setCollectResults(true);</b></span>{@code
* concurrentQ = builder.getQueue(callback);
* ...
* ...
@ -99,7 +99,7 @@ import ghidra.util.task.TaskMonitor;
* concurrentQ.add(item);
* concurrentQ.add(item);
* ...
* }<font color="blue"><b>{@literal List<QResult<I, R>> results = concurrentQ.waitForResults();}</b></font>{@literal
* }<span style="color:blue"><b>{@literal List<QResult<I, R>> results = concurrentQ.waitForResults();}</b></span>{@literal
* // process the results...
*
* }</pre>
@ -122,19 +122,19 @@ import ghidra.util.task.TaskMonitor;
*
* ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>();
* builder.setThreadPoolName("Thread Pool Name");
* }<font color="blue"><b>builder.setQueue(new LinkedBlockingQueue(100));</b></font>{@literal
* }<span style="color:blue"><b>builder.setQueue(new LinkedBlockingQueue(100));</b></span>{@literal
* concurrentQ = builder.getQueue(callback);
* ...
* ...
* Iterator<ITEM> iterator = <get an iterator for 1000s of items somewhere>
* }<font color="blue"><b>{@code concurrentQ.offer(iterator); // this call will block when the queue fills up (100 items or more)}</b></font>
* }<span style="color:blue"><b>{@code concurrentQ.offer(iterator); // this call will block when the queue fills up (100 items or more)}</b></span>
*
* </pre>
* <hr>
*
* @param <I> The type of the items to be processed.
* @param <R> The type of objects resulting from processing an item; if you don't care about the
* return value, then make this value whatever you want, like <tt>Object</tt> or the
* return value, then make this value whatever you want, like <code>Object</code> or the
* same value as {@link I} and return null from {@link QCallback#process(Object, TaskMonitor)}.
*/
public class ConcurrentQ<I, R> {
@ -291,12 +291,12 @@ public class ConcurrentQ<I, R> {
/**
* Allows clients to use a bounded queue (such as a {@link LinkedBlockingQueue} to control
* how many items get placed into this queue at one time. Calling the <tt>add</tt> methods
* how many items get placed into this queue at one time. Calling the <code>add</code> methods
* will place all items into the queue, which for a large number of items, can consume a
* large amount of memory. This method will block once the queue at maximum capacity,
* continuing to add new items as existing items on the queue are processed.
* <p>
* To enable blocking on the queue when it is full, construct this <tt>ConcurrentQ</tt>
* To enable blocking on the queue when it is full, construct this <code>ConcurrentQ</code>
* with an instance of {@link BlockingQueue}.
*
* @param iterator An iterator from which items will be taken.
@ -414,7 +414,7 @@ public class ConcurrentQ<I, R> {
* exception, then you should instead use {@link #waitForResults()}. That method will return
* all results, both with and without exceptions, which you can then process, including
* checking for exceptions. Note that to use {@link #waitForResults()} to examine exceptions,
* you must have created this queue with <tt>collectResults</tt> as true.
* you must have created this queue with <code>collectResults</code> as true.
*
* @throws InterruptedException if interrupted while waiting for a result
* @throws Exception any exception encountered while processing an item (this will cancel all

2
Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java
View file

@ -181,7 +181,7 @@ public class ConcurrentQBuilder<I, R> {
/**
* @see ConcurrentQ#setMonitor(TaskMonitor, boolean)
* <p>
* The default value is <tt>true</tt>.
* The default value is <code>true</code>.
*/
public ConcurrentQBuilder<I, R> setCancelClearsAllJobs(boolean clearAllJobs) {
this.cancelClearsAllJobs = clearAllJobs;

2
Ghidra/Framework/Generic/src/main/java/generic/concurrent/QCallback.java
View file

@ -24,7 +24,7 @@ import ghidra.util.task.TaskMonitor;
*
* @param <I> The type of the items to be processed.
* @param <R> The type of objects resulting from processing an item; if you don't care about the
* return value, then make this value whatever you want, like <tt>Object</tt> or the
* return value, then make this value whatever you want, like <code>Object</code> or the
* same value as {@link I} and return null from {@link #process(Object, TaskMonitor) process(I, TaskMonitor)}.
*/
public interface QCallback<I, R> {

12
Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java
View file

@ -502,7 +502,7 @@ public abstract class AbstractGenericTest extends AbstractGTest {
/**
* Sets the instance field by the given name on the given object instance.
* <p>
* Note: if the field is static, then the <tt>ownerInstance</tt> field can
* Note: if the field is static, then the <code>ownerInstance</code> field can
* be the class of the object that contains the variable.
*
* @param fieldName The name of the field to retrieve.
@ -524,7 +524,7 @@ public abstract class AbstractGenericTest extends AbstractGTest {
* Gets the instance field by the given name on the given object instance.
* The value is a primitive wrapper if it is a primitive type.
* <p>
* Note: if the field is static, then the <tt>ownerInstance</tt> field can
* Note: if the field is static, then the <code>ownerInstance</code> field can
* be the class of the object that contains the variable.
*
* @param fieldName The name of the field to retrieve.
@ -570,9 +570,9 @@ public abstract class AbstractGenericTest extends AbstractGTest {
/**
* Uses reflection to execute the method denoted by the given method name.
* If any value is returned from the method execution, then it will be
* returned from this method. Otherwise, <tt>null</tt> is returned.
* returned from this method. Otherwise, <code>null</code> is returned.
* <p>
* Note: if the method is static, then the <tt>ownerInstance</tt> field can
* Note: if the method is static, then the <code>ownerInstance</code> field can
* be the class of the object that contains the method.
*
* @param methodName The name of the method to execute.
@ -1775,7 +1775,7 @@ public abstract class AbstractGenericTest extends AbstractGTest {
/**
* Creates a file path with a filename that is under the system temp
* directory. The path returned will not point to an existing file. The
* suffix of the file will be <tt>.tmp</tt>.
* suffix of the file will be <code>.tmp</code>.
*
* @param name the filename
* @return a new file path
@ -1839,7 +1839,7 @@ public abstract class AbstractGenericTest extends AbstractGTest {
* prefix and the given suffix. The final filename will also include the
* current test name, as well as any data added by
* {@link File#createTempFile(String, String)}. The file suffix will be
* <tt>.tmp</tt>
* <code>.tmp</code>
* <p>
* The file will be marked to delete on JVM exit. This will not work if the
* JVM is taken down the hard way, as when pressing the stop button in

24
Ghidra/Framework/Generic/src/main/java/generic/test/TestUtils.java
View file

@ -51,7 +51,7 @@ public class TestUtils {
* Sets the instance field by the given name on the given object
* instance.
* <p>
* Note: if the field is static, then the <tt>ownerInstance</tt> field
* Note: if the field is static, then the <code>ownerInstance</code> field
* can be the class of the object that contains the variable.
*
* @param fieldName The name of the field to retrieve.
@ -92,7 +92,7 @@ public class TestUtils {
* Gets the instance field by the given name on the given object
* instance. The value is a primitive wrapper if it is a primitive type.
* <p>
* Note: if the field is static, then the <tt>ownerInstance</tt> field
* Note: if the field is static, then the <code>ownerInstance</code> field
* can be the class of the object that contains the variable.
*
* @param fieldName The name of the field to retrieve.
@ -168,9 +168,9 @@ public class TestUtils {
/**
* Uses reflection to execute the method denoted by the given method
* name. If any value is returned from the method execution, then it
* will be returned from this method. Otherwise, <tt>null</tt> is returned.
* will be returned from this method. Otherwise, <code>null</code> is returned.
* <p>
* Note: if the method is static, then the <tt>ownerInstance</tt> field
* Note: if the method is static, then the <code>ownerInstance</code> field
* can be the class of the object that contains the method.
*
* @param methodName The name of the method to execute.
@ -226,9 +226,9 @@ public class TestUtils {
/**
* Uses reflection to execute the method denoted by the given method
* name. If any value is returned from the method execution, then it
* will be returned from this method. Otherwise, <tt>null</tt> is returned.
* will be returned from this method. Otherwise, <code>null</code> is returned.
* <p>
* Note: if the method is static, then the <tt>ownerInstance</tt> field
* Note: if the method is static, then the <code>ownerInstance</code> field
* can be the class of the object that contains the method.
*
* <P>This method is just a convenience for calling
@ -264,9 +264,9 @@ public class TestUtils {
/**
* Uses reflection to execute the method denoted by the given method
* name. If any value is returned from the method execution, then it
* will be returned from this method. Otherwise, <tt>null</tt> is returned.
* will be returned from this method. Otherwise, <code>null</code> is returned.
* <p>
* Note: if the method is static, then the <tt>ownerInstance</tt> field
* Note: if the method is static, then the <code>ownerInstance</code> field
* can be the class of the object that contains the method.
*
* <P>If the method you are calling takes no parameters, then call
@ -305,9 +305,9 @@ public class TestUtils {
/**
* Uses reflection to execute the method denoted by the given method
* name. If any value is returned from the method execution, then it
* will be returned from this method. Otherwise, <tt>null</tt> is returned.
* will be returned from this method. Otherwise, <code>null</code> is returned.
* <p>
* Note: if the method is static, then the <tt>ownerInstance</tt> field
* Note: if the method is static, then the <code>ownerInstance</code> field
* can be the class of the object that contains the method.
*
* <P><B>Warning: The exact class of each <CODE>arg</CODE> will be used as the class type
@ -458,9 +458,9 @@ public class TestUtils {
}
/**
* Locates the method of the name <tt>methodName</tt> on the given
* Locates the method of the name <code>methodName</code> on the given
* class. If the given class does not contain the method, then this
* method will recursively call up <tt>containingClass</tt>'s
* method will recursively call up <code>containingClass</code>'s
* implementation tree looking for a parent implementation of the
* requested method.
*

2
Ghidra/Framework/Generic/src/main/java/generic/util/MultiIterator.java
View file

@ -20,7 +20,7 @@ import java.util.*;
import ghidra.util.exception.AssertException;
/**
* An iterator that is comprised of one or more {@link PeekableIterator}s. The type <tt>T</tt> of the
* An iterator that is comprised of one or more {@link PeekableIterator}s. The type <code>T</code> of the
* the iterators must either implement {@link Comparable} directly or you must provide a
* {@link Comparator} for comparing the types. Further, it is assumed that the iterators return
* values in sorted order. If the sorted order is reversed, then that must be indicated in

2
Ghidra/Framework/Generic/src/main/java/generic/util/PeekableIterator.java
View file

@ -27,7 +27,7 @@ public interface PeekableIterator<T> extends Iterator<T> {
/**
* Returns the item that would be returned by calling {@link #next()}, but does not
* increment the iterator as <tt>next</tt> would.
* increment the iterator as <code>next</code> would.
*
* @return the item that would be returned by calling {@link #next()}
*/

8
Ghidra/Framework/Generic/src/main/java/generic/util/WindowUtilities.java
View file

@ -217,12 +217,12 @@ public class WindowUtilities {
}
/**
* Creates a point that is centered over the given <tt>parent</tt> component, based upon
* the size of the given <tt>child</tt>.
* Creates a point that is centered over the given <code>parent</code> component, based upon
* the size of the given <code>child</code>.
* @param parent The component over which to center the child.
* @param child The component which will be centered over the parent
* @return a point that is centered over the given <tt>parent</tt> component, based upon
* the size of the given <tt>child</tt>.
* @return a point that is centered over the given <code>parent</code> component, based upon
* the size of the given <code>child</code>.
*/
public static Point centerOnComponent(Component parent, Component child) {
Dimension parentSize = parent.getSize();

6
Ghidra/Framework/Generic/src/main/java/generic/util/image/ImageUtils.java
View file

@ -269,7 +269,7 @@ public class ImageUtils {
}
/**
* Writes the given icon out to the file denoted by <tt>filename</tt> <b> in the PNG format</b>.
* Writes the given icon out to the file denoted by <code>filename</code> <b> in the PNG format</b>.
*
* @param icon the icon to write
* @param filename the filename denoting the write destination
@ -412,13 +412,13 @@ public class ImageUtils {
/**
* Takes in RGB pixel data and then converts the pixel into a gray color with a brightness
* based upon <tt>brightnessPercent</tt>.
* based upon <code>brightnessPercent</code>.
*
* @param rgbPixels The RGB pixel data for a given pixel.
* @param destination The converted pixel data.
* @param brightnessPercent The amount of brightness to include in the gray value, where 100
* percent is the brightest possible value.
* @return The <tt>destination</tt> array filled with the new pixel data.
* @return The <code>destination</code> array filled with the new pixel data.
*/
private static int[] filterRgbDisabledImage(int[] rgbPixels, int[] destination,
int brightnessPercent) {

2
Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java
View file

@ -579,7 +579,7 @@ public class Application {
* <b>Note: Be sure you understand that there may be multiple application root
* directories in development mode.</b> In general you should not be using this method for
* searching for files yourself, but instead using
* the various <tt>find*</tt> methods of this class.
* the various <code>find*</code> methods of this class.
*
* @return Returns the application root directory.
* @see #getApplicationRootDirectories()

8
Ghidra/Framework/Generic/src/main/java/ghidra/framework/preferences/Preferences.java
View file

@ -192,7 +192,7 @@ public class Preferences {
/**
* Get the property with the given name.
* <p>
* Note: all <tt>getProperty(...)</tt> methods will first check {@link System#getProperty(String)}
* Note: all <code>getProperty(...)</code> methods will first check {@link System#getProperty(String)}
* for a value first. This allows users to override preferences from the command-line.
*/
public static String getProperty(String name) {
@ -208,7 +208,7 @@ public class Preferences {
/**
* Get the property with the given name; if there is no property, return the defaultValue.
* <p>
* Note: all <tt>getProperty(...)</tt> methods will first check {@link System#getProperty(String)}
* Note: all <code>getProperty(...)</code> methods will first check {@link System#getProperty(String)}
* for a value first. This allows users to override preferences from the command-line.
*
* @see #getProperty(String, String, boolean)
@ -226,10 +226,10 @@ public class Preferences {
/**
* Get the property with the given name; if there is no property, return the defaultValue.
* <p>
* This version of <tt>getProperty</tt> will, when <tt>useHistoricalValue</tt> is true, look
* This version of <code>getProperty</code> will, when <code>useHistoricalValue</code> is true, look
* for the given preference value in the last used installation of the application.
* <p>
* Note: all <tt>getProperty(...)</tt> methods will first check {@link System#getProperty(String)}
* Note: all <code>getProperty(...)</code> methods will first check {@link System#getProperty(String)}
* for a value first. This allows users to override preferences from the command-line.
*
* @param name The name of the property for which to get a value

6
Ghidra/Framework/Generic/src/main/java/ghidra/util/CascadedDropTarget.java
View file

@ -117,10 +117,10 @@ public class CascadedDropTarget extends DropTarget {
/**
* Removes the given drop target from anywhere within the tree of CascadedDropTargets.
*
* If the given <tt>dropTarget</tt> is an immediate child of this CascadedDropTarget (CDT), then
* If the given <code>dropTarget</code> is an immediate child of this CascadedDropTarget (CDT), then
* the other child is returned. Otherwise, a reference to this CDT will be returned with the
* given <tt>dropTarget</tt> having been removed from one of this CDT's children. This method
* effectively removes the given <tt>dropTarget</tt> from the hierarchy and collapses the tree
* given <code>dropTarget</code> having been removed from one of this CDT's children. This method
* effectively removes the given <code>dropTarget</code> from the hierarchy and collapses the tree
* structure as needed.
*
* @param dropTarget The target to remove

24
Ghidra/Framework/Generic/src/main/java/ghidra/util/HTMLUtilities.java
View file

@ -34,7 +34,7 @@ import utilities.util.reflection.ReflectionUtilities;
*
* <P>Many clients use this class to render content as HTML. Below are a few use cases along
* with the method that should be used for each.
* <TABLE BORDER="1">
* <TABLE BORDER="1"><caption></caption>
* <TR>
* <TH>Use Case</TH><TH>Function</TH><TH>Description</TH>
* </TR>
@ -355,14 +355,14 @@ public class HTMLUtilities {
/**
* Returns the given text wrapped in {@link #LINK_PLACEHOLDER_OPEN} and close tags.
* If <tt>foo</tt> is passed for the HTML text, with a content value of <tt>123456</tt>, then
* If <code>foo</code> is passed for the HTML text, with a content value of <code>123456</code>, then
* the output will look like:
* <pre>
* &lt;!-- LINK CONTENT="123456" --&gt;foo&lt;!-- /LINK --&gt;
* </pre>
*
* @param htmlText the HTML text to wrap
* @param content the value that will be put into the <tt>CONTENT</tt> section of the
* @param content the value that will be put into the <code>CONTENT</code> section of the
* generated HTML. This can later be retrieved by clients transforming this text.
* @return the wrapped text
*/
@ -375,8 +375,8 @@ public class HTMLUtilities {
/**
* Takes HTML text wrapped by {@link #wrapWithLinkPlaceholder(String, String)} and replaces
* the custom link comment tags with HTML anchor (<tt>A</tt>) tags, where the <tt>HREF</tt>
* value is the value that was in the <tt>CONTENT</tt> attribute.
* the custom link comment tags with HTML anchor (<code>A</code>) tags, where the <code>HREF</code>
* value is the value that was in the <code>CONTENT</code> attribute.
*
* @param text the text for which to replace the markup
* @return the updated text
@ -428,9 +428,9 @@ public class HTMLUtilities {
/**
* Similar to {@link #toHTML(String)} in that it will wrap the given text in
* HTML tags and split the content into multiple lines. The difference is that this method
* will split lines that pass the given maximum length <b>and</b> on <tt>'\n'</tt>
* will split lines that pass the given maximum length <b>and</b> on <code>'\n'</code>
* characters. Alternatively, {@link #toHTML(String)} will only split the given
* text on <tt>'\n'</tt> characters.
* text on <code>'\n'</code> characters.
*
* @param text The text to convert
* @param maxLineLength The maximum number of characters that should appear in a line;
@ -487,7 +487,7 @@ public class HTMLUtilities {
*
* <P>For example, consider the following<br><br>
*
* <table border=1>
* <table border=1><caption></caption>
* <tr>
* <th>Input</th><th>Output</th><th>Rendered as</th><th>(Without Friendly Encoding)</th>
* </tr>
@ -496,10 +496,10 @@ public class HTMLUtilities {
* Hi &lt;b&gt;mom &lt;/b&gt;
* </td>
* <td>
* Hi<font color="green">
* &#x26;nbsp;<b>&#x26;lt;</b></font>b<font color="green"><b>&#x26;gt;</b></font>mom
* <font color="green">&#x26;nbsp;<b>&#x26;lt;</b></font>/b<font color="green"><b>&#x26;gt;</b>
* </font>
* Hi<span style="color:green">
* &#x26;nbsp;<b>&#x26;lt;</b></span>b<span style="color:green"><b>&#x26;gt;</b></span>mom
* <span style="color:green">&#x26;nbsp;<b>&#x26;lt;</b></span>/b<span style="color:green"><b>&#x26;gt;</b>
* </span>
* </td>
* <td>
* Hi &lt;b&gt;mom &lt;/b&gt;

4
Ghidra/Framework/Generic/src/main/java/ghidra/util/HelpLocation.java
View file

@ -44,7 +44,7 @@ public class HelpLocation {
* An html file contained within the specified help topic directory must have an Anchor
* defined using the specified anchor name.
* <p>
* <b>Note:</b> You can specify a <tt>null</tt> anchor value. In that case, the given topic
* <b>Note:</b> You can specify a <code>null</code> anchor value. In that case, the given topic
* will be searched for a file with the same name as the topic. If such a file exists,
* then that file will be used as the file for this location. If no such file exists, then
* the help file to use <b>cannot be resolved</b>. Therefore, it is best to always specify
@ -62,7 +62,7 @@ public class HelpLocation {
* An html file contained within the specified help topic directory must have an Anchor
* defined using the specified anchor name.
* <p>
* <b>Note:</b> You can specify a <tt>null</tt> anchor value. In that case, the given topic
* <b>Note:</b> You can specify a <code>null</code> anchor value. In that case, the given topic
* will be searched for a file with the same name as the topic. If such a file exists,
* then that file will be used as the file for this location. If no such file exists, then
* the help file to use <b>cannot be resolved</b>. Therefore, it is best to always specify

38
Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java
View file

@ -497,7 +497,7 @@ public final class NumericUtilities {
/**
* Render <code>number</code> in different bases using the default signedness mode.
* <p>This invokes {@linkplain #formatNumber(long, int, SignednessFormatMode)} with a
* <tt>mode</tt> parameter of <tt>{@linkplain SignednessFormatMode#DEFAULT}</tt>.
* <code>mode</code> parameter of <code>{@linkplain SignednessFormatMode#DEFAULT}</code>.
*
* @param number The number to represent
* @param radix the base in which <code>number</code> is represented
@ -511,29 +511,29 @@ public final class NumericUtilities {
/**
* Provide renderings of <code>number</code> in different bases:
* <ul>
* <li> 0 - renders <code>number</code> as an escaped character sequence</li>
* <li> 2 - renders <code>number</code> as a base-2 integer</li>
* <li> 8 - renders <code>number</code> as a base-8 integer</li>
* <li> 10 - renders <code>number</code> as a base-10 integer</li>
* <li> 16 (default) - renders <code>number</code> base-16 integer</li>
* <li> <code>0</code> - renders <code>number</code> as an escaped character sequence</li>
* <li> <code>2</code> - renders <code>number</code> as a <code>base-2</code> integer</li>
* <li> <code>8</code> - renders <code>number</code> as a <code>base-8</code> integer</li>
* <li> <code>10</code> - renders <code>number</code> as a <code>base-10</code> integer</li>
* <li> <code>16</code> (default) - renders <code>number</code> as a <code>base-16</code> integer</li>
* </ul>
* <table><caption></caption>
* <tr><th>Number</th><th>Radix</th><th>DEFAULT Mode Alias</th><th><i>UNSIGNED</i> Mode Value</th><th><i>SIGNED</i> Mode Value</th></tr>
* <tr><th>Number</th><th>Radix</th><th>DEFAULT Mode Alias</th><th style="text-align:center"><i>UNSIGNED</i> Mode Value</th><th><i>SIGNED</i> Mode Value</th></tr>
* <tr><td>&nbsp;</td><td></td><td><i></i></td><td></td><td></td></tr>
* <tr align=right><td>100</td><td>2</td><td><i>UNSIGNED</i></td><td>1100100b</td><td>1100100b</td></tr>
* <tr align=right><td>100</td><td>8</td><td><i>UNSIGNED</i></td><td>144o</td><td>144o</td></tr>
* <tr align=right><td>100</td><td>10</td><td><i>SIGNED</i></td><td>100</td><td>100</td></tr>
* <tr align=right><td>100</td><td>16</td><td><i>UNSIGNED</i></td><td>64h</td><td>64h</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>100</td><td>2</td><td><i>UNSIGNED</i></td><td>1100100b</td><td>1100100b</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>100</td><td>8</td><td><i>UNSIGNED</i></td><td>144o</td><td>144o</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>100</td><td>10</td><td><i>SIGNED</i></td><td>100</td><td>100</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>100</td><td>16</td><td><i>UNSIGNED</i></td><td>64h</td><td>64h</td></tr>
* <tr><td>&nbsp;</td><td></td><td><i></i></td><td></td><td></td></tr>
* <tr align=right><td>-1</td><td>2</td><td><i>UNSIGNED</i></td><td>1111111111111111111111111111111111111111111111111111111111111111b</td><td>-1b</td></tr>
* <tr align=right><td>-1</td><td>8</td><td><i>UNSIGNED</i></td><td>1777777777777777777777o</td><td>-1o</td></tr>
* <tr align=right><td>-1</td><td>10</td><td><i>SIGNED</i></td><td>18446744073709551615</td><td>-1</td></tr>
* <tr align=right><td>-1</td><td>16</td><td><i>UNSIGNED</i></td><td>ffffffffffffffffh</td><td>-1h</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>-1</td><td>2</td><td><i>UNSIGNED</i></td><td>1111111111111111111111111111111111111111111111111111111111111111b</td><td>-1b</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>-1</td><td>8</td><td><i>UNSIGNED</i></td><td>1777777777777777777777o</td><td>-1o</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>-1</td><td>10</td><td><i>SIGNED</i></td><td>18446744073709551615</td><td>-1</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>-1</td><td>16</td><td><i>UNSIGNED</i></td><td>ffffffffffffffffh</td><td>-1h</td></tr>
*<tr><td>&nbsp;</td><td></td><td><i></i></td><td></td><td></td></tr>
* <tr align=right><td>-100</td><td>2</td><td><i>UNSIGNED</i></td><td>1111111111111111111111111111111111111111111111111111111110011100b</td><td>-1100100b</td></tr>
* <tr align=right><td>-100</td><td>8</td><td><i>UNSIGNED</i></td><td>1777777777777777777634o</td><td>-144o</td></tr>
* <tr align=right><td>-100</td><td>10</td><td><i>SIGNED</i></td><td>18446744073709551516</td><td>-100</td></tr>
* <tr align=right><td>-100</td><td>16</td><td><i>UNSIGNED</i></td><td>ffffffffffffff9ch</td><td>-64h</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>-100</td><td>2</td><td><i>UNSIGNED</i></td><td>1111111111111111111111111111111111111111111111111111111110011100b</td><td>-1100100b</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>-100</td><td>8</td><td><i>UNSIGNED</i></td><td>1777777777777777777634o</td><td>-144o</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>-100</td><td>10</td><td><i>SIGNED</i></td><td>18446744073709551516</td><td>-100</td></tr>
* <tr style="text-align:right;font-family: monospace"><td>-100</td><td>16</td><td><i>UNSIGNED</i></td><td>ffffffffffffff9ch</td><td>-64h</td></tr>
* </table>
* @param number The number to represent
* @param radix The base in which <code>number</code> is represented

6
Ghidra/Framework/Generic/src/main/java/ghidra/util/Saveable.java
View file

@ -48,9 +48,9 @@ public interface Saveable {
* Returns the field classes, in Java types, in the same order as used {@link #save} and
* {@link #restore}.
* <p>
* For example, if the save method calls <tt>objStorage.putInt()</tt> and then
* <tt>objStorage.putFloat()</tt>, then this method must return
* <tt>Class[]{ Integer.class, Float.class }</tt>.
* For example, if the save method calls <code>objStorage.putInt()</code> and then
* <code>objStorage.putFloat()</code>, then this method must return
* <code>Class[]{ Integer.class, Float.class }</code>.
* @return
*/
Class<?>[] getObjectStorageFields();

20
Ghidra/Framework/Generic/src/main/java/ghidra/util/StringUtilities.java
View file

@ -309,7 +309,7 @@ public class StringUtilities {
}
/**
* Returns true if the given string starts with <tt>prefix</tt> ignoring case.
* Returns true if the given string starts with <code>prefix</code> ignoring case.
* <p>
* Note: This method is equivalent to calling:
* <pre>
@ -318,7 +318,7 @@ public class StringUtilities {
*
* @param string the string which may contain the prefix
* @param prefix the prefix to test against
* @return true if the given string starts with <tt>prefix</tt> ignoring case.
* @return true if the given string starts with <code>prefix</code> ignoring case.
*/
public static boolean startsWithIgnoreCase(String string, String prefix) {
if ((string == null) || (prefix == null)) {
@ -328,7 +328,7 @@ public class StringUtilities {
}
/**
* Returns true if the given string ends with <tt>postfix</tt>, ignoring case.
* Returns true if the given string ends with <code>postfix</code>, ignoring case.
* <p>
* Note: This method is equivalent to calling:
* <pre>
@ -336,9 +336,9 @@ public class StringUtilities {
* string.regionMatches( true, startOffset, postfix, 0, postfix.length() );
* </pre>
*
* @param string the string which may end with <tt>postfix</tt>
* @param string the string which may end with <code>postfix</code>
* @param postfix the string for which to test existence
* @return true if the given string ends with <tt>postfix</tt>, ignoring case.
* @return true if the given string ends with <code>postfix</code>, ignoring case.
*/
public static boolean endsWithIgnoreCase(String string, String postfix) {
if ((string == null) || (postfix == null)) {
@ -349,11 +349,11 @@ public class StringUtilities {
}
/**
* Returns true if all the given <tt>searches</tt> are contained in the given string.
* Returns true if all the given <code>searches</code> are contained in the given string.
*
* @param toSearch the string to search
* @param searches the strings to find
* @return true if all the given <tt>searches</tt> are contained in the given string.
* @return true if all the given <code>searches</code> are contained in the given string.
*/
public static boolean containsAll(CharSequence toSearch, CharSequence... searches) {
if (StringUtils.isEmpty(toSearch) || ArrayUtils.isEmpty(searches)) {
@ -369,12 +369,12 @@ public class StringUtilities {
}
/**
* Returns true if all the given <tt>searches</tt> are contained in the given string,
* Returns true if all the given <code>searches</code> are contained in the given string,
* ignoring case.
*
* @param toSearch the string to search
* @param searches the strings to find
* @return true if all the given <tt>searches</tt> are contained in the given string.
* @return true if all the given <code>searches</code> are contained in the given string.
*/
public static boolean containsAllIgnoreCase(CharSequence toSearch, CharSequence... searches) {
if (StringUtils.isEmpty(toSearch) || ArrayUtils.isEmpty(searches)) {
@ -838,7 +838,7 @@ public class StringUtilities {
}
/**
* Limits the given string to the given <tt>max</tt> number of characters. If the string is
* Limits the given string to the given <code>max</code> number of characters. If the string is
* larger than the given length, then it will be trimmed to fit that length <b>after adding
* ellipses</b>
*

4
Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackKeySet.java
View file

@ -640,7 +640,7 @@ public class RedBlackKeySet implements ShortKeySet, Serializable {
}
/**
* Save the state of the <tt>TreeMap</tt> instance to a stream (i.e.,
* Save the state of the <code>TreeMap</code> instance to a stream (i.e.,
* serialize it).
*
* @serialData The <i>size</i> of the TreeMap (the number of key-value
@ -665,7 +665,7 @@ public class RedBlackKeySet implements ShortKeySet, Serializable {
}
/**
* Reconstitute the <tt>TreeMap</tt> instance from a stream (i.e.,
* Reconstitute the <code>TreeMap</code> instance from a stream (i.e.,
* deserialize it).
*/
private void readObject(final java.io.ObjectInputStream s) throws java.io.IOException,

4
Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackLongKeySet.java
View file

@ -640,7 +640,7 @@ public class RedBlackLongKeySet implements Serializable {
/**
* Save the state of the <tt>TreeMap</tt> instance to a stream (i.e.,
* Save the state of the <code>TreeMap</code> instance to a stream (i.e.,
* serialize it).
*
* @serialData The <i>size</i> of the TreeMap (the number of key-value
@ -668,7 +668,7 @@ public class RedBlackLongKeySet implements Serializable {
/**
* Reconstitute the <tt>TreeMap</tt> instance from a stream (i.e.,
* Reconstitute the <code>TreeMap</code> instance from a stream (i.e.,
* deserialize it).
*/
private void readObject(final java.io.ObjectInputStream s)

8
Ghidra/Framework/Generic/src/main/java/ghidra/util/task/SwingUpdateManager.java
View file

@ -34,7 +34,7 @@ import utilities.util.reflection.ReflectionUtilities;
* <p>
* The various methods dictate when the client will get a callback:<p>
* <ul>
* <li>{@link #update()} - if this is the first call to <tt>update</tt>, then do the work
* <li>{@link #update()} - if this is the first call to <code>update</code>, then do the work
* immediately; otherwise, buffer the update request until the
* timeout has expired.</li>
* <li>{@link #updateNow()} - perform the callback now.</li>
@ -93,7 +93,7 @@ public class SwingUpdateManager {
/**
* Constructs a new SwingUpdateManager
* <p>
* <b>Note: </b>The <tt>minDelay</tt> will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
* <b>Note: </b>The <code>minDelay</code> will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
* the given value.
*
* @param minDelay the minimum number of milliseconds to wait once the event stream stops
@ -107,7 +107,7 @@ public class SwingUpdateManager {
/**
* Constructs a new SwingUpdateManager
* <p>
* <b>Note: </b>The <tt>minDelay</tt> will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
* <b>Note: </b>The <code>minDelay</code> will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
* the given value.
*
* @param minDelay the minimum number of milliseconds to wait once the event stream stops
@ -122,7 +122,7 @@ public class SwingUpdateManager {
/**
* Constructs a new SwingUpdateManager
* <p>
* <b>Note: </b>The <tt>minDelay</tt> will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
* <b>Note: </b>The <code>minDelay</code> will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
* the given value.
*
* @param minDelay the minimum number of milliseconds to wait once the event stream stops

2
Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/GenericXMLOutputter.java
View file

@ -21,7 +21,7 @@ import org.jdom.output.XMLOutputter;
import org.jdom.output.Format.TextMode;
/**
* A simple extension of <tt>XMLOutputter</tt> that sets default settings to fix common bugs.
* A simple extension of <code>XMLOutputter</code> that sets default settings to fix common bugs.
*/
public class GenericXMLOutputter extends XMLOutputter {

16
Ghidra/Framework/Generic/src/main/java/resources/ResourceManager.java
View file

@ -40,7 +40,7 @@ import utility.module.ModuleUtilities;
* General resource management class that provides a convenient
* way of accessing external resources used in Ghidra.
* <p>
* <a name="safe"></a>
* <a id="safe"></a>
* There is a known problem with Java's {@link MediaTracker} that can cause deadlocks. The various
* methods of this class that create {@link ImageIcon}s will do so by loading image bytes directly,
* as opposed to using the flawed constructor {@link ImageIcon#ImageIcon(Image)}.
@ -158,10 +158,10 @@ public class ResourceManager {
}
/**
* Search the classpath for files in the &lt;classpath entry&gt;/<tt>dirName</tt>
* location that have the given extension. In <tt>null</tt> is passed for the
* Search the classpath for files in the &lt;classpath entry&gt;/<code>dirName</code>
* location that have the given extension. In <code>null</code> is passed for the
* extension, then all files found in the given dir names will be returned. In this
* way, <tt>null</tt> is a wildcard.
* way, <code>null</code> is a wildcard.
*
* <P>This method differs from {@link #getResource(String)} in that this method finds
* multiple matches.
@ -181,10 +181,10 @@ public class ResourceManager {
}
/**
* Search the classpath for files in the &lt;classpath entry&gt;/<tt>dirName</tt>
* location that have the given extension. In <tt>null</tt> is passed for the
* Search the classpath for files in the &lt;classpath entry&gt;/<code>dirName</code>
* location that have the given extension. In <code>null</code> is passed for the
* extension, then all files found in the given dir names will be returned. In this
* way, <tt>null</tt> is a wildcard.
* way, <code>null</code> is a wildcard.
*
* <P>The names returned from this method are relative and are meant to be used in a
* later callback to this class for methods such as {@link #loadImage(String)} or
@ -371,7 +371,7 @@ public class ResourceManager {
}
/**
* Creates an image icon from the given image. This method will create an <tt>ImageIcon</tt>
* Creates an image icon from the given image. This method will create an <code>ImageIcon</code>
* the <a href="safe">"safe"</a> way by avoiding the constructor
* {@link ImageIcon#ImageIcon(Image)}, which can
* trigger problems with Java's {@link MediaTracker}.

2
Ghidra/Framework/Generic/src/main/java/util/HistoryList.java
View file

@ -107,7 +107,7 @@ public class HistoryList<T> {
}
/**
* Adds an item to this history list. <tt>null</tt> values are ignored.
* Adds an item to this history list. <code>null</code> values are ignored.
*
* <p>Calls to this method during selection notification will have no effect. If you need
* to update the history during a notification, then you must do so at a later time, perhaps