Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc html5 changes #1337

Merged
merged 1 commit into from
Dec 17, 2019
Merged

Javadoc html5 changes #1337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Ghidra/Features/Base/src/main/java/ghidra/app/cmd/label/CreateNamespacesCmd.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@
* string. Thus, when providing a namespace string, do not include the name
* of anything other than namespaces, such as the name of a symbol.
* <p>
* <a name="examples"></a>
* <a id="examples"></a>
* Example strings:
* <ul>
* <li>global{@link Namespace#NAMESPACE_DELIMITER ::}child1{@link Namespace#NAMESPACE_DELIMITER ::}child2
* <li>child1
* </ul>
* <p>
* <a name="assumptions"></a>
* <a id="assumptions"></a>
* To view the assumptions for creating namespaces from a path string, see
* the {@link NamespaceUtils} class.
*
Expand Down Expand Up @@ -79,7 +79,7 @@ public CreateNamespacesCmd(String namespacesString, SourceType source) {
* @param parentNamespace The namespace to be used as the starting parent
* of the namespaces that will be created.
* @param source the source of the namespace
* @throws NullPointerException if <tt>namespaceString</tt> is <tt>null</tt>.
* @throws NullPointerException if <code>namespaceString</code> is <code>null</code>.
* @see <a href="#examples">example format</a>
* @see <a href="#assumptions">assumptions</a>
*/
Expand Down
16 changes: 8 additions & 8 deletions Ghidra/Features/Base/src/main/java/ghidra/app/script/GhidraScript.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -950,10 +950,10 @@ public void println(String message) {
}

/**
* A convenience method to print a formatted String using Java's <tt>printf</tt>
* A convenience method to print a formatted String using Java's <code>printf</code>
* feature, which is similar to that of the C programming language.
* For a full description on Java's
* <tt>printf</tt> usage, see {@link java.util.Formatter}.
* <code>printf</code> usage, see {@link java.util.Formatter}.
* <p>
* For examples, see the included <code>FormatExampleScript</code>.
* <p>
Expand Down Expand Up @@ -1535,8 +1535,8 @@ public void setCurrentHighlight(AddressSetView addressSet) {

/**
* Sets this script's highlight state (both the local variable
* <tt>currentHighlight</tt> and the
* <tt>GhidraState</tt>'s currentHighlight) to the given address set. Also sets the tool's highlight
* <code>currentHighlight</code> and the
* <code>GhidraState</code>'s currentHighlight) to the given address set. Also sets the tool's highlight
* if the tool exists. (Same as calling setCurrentHightlight(set);
* @param set the set of addresses to include in the highlight. May be null.
*/
Expand Down Expand Up @@ -1859,8 +1859,8 @@ public File parseFile(String s) {
/**
* Attempts to locate a value from script arguments
* or a script properties file using
* the given <tt>keys</tt> as the lookup key for the latter. The given <tt>parser</tt> will
* be called to turn the String into a <tt>T</tt>.
* the given <code>keys</code> as the lookup key for the latter. The given <code>parser</code> will
* be called to turn the String into a <code>T</code>.
*
* @param transformer the function to turn a String into a T
* @param key the values used to create a key for lookup in the script properties file
Expand All @@ -1883,7 +1883,7 @@ private <T> T loadAskValue(StringTransformer<T> transformer, String key) {
* @return null if no value was found in the aforementioned sources
*
* @throws IllegalArgumentException if the loaded String value cannot be parsed into a
* <tt>T</tt>.
* <code>T</code>.
*/
private <T> T loadAskValue(T defaultValue, StringTransformer<T> transformer, String key) {

Expand Down Expand Up @@ -1936,7 +1936,7 @@ private <T> T loadAskValue(T defaultValue, StringTransformer<T> transformer, Str
/**
* A generic method to execute user prompting for a value. This method handles:
* <ol>
* <li>Checking for a previously chosen value; using the optional <tt>defaultValue</tt> as a fallback</li>
* <li>Checking for a previously chosen value; using the optional <code>defaultValue</code> as a fallback</li>
* <li>Calling the provided function to execute the client-specific ask UI</li>
* <li>Storing the chosen result after the dialog is closed</li>
* </ol>
Expand Down
2 changes: 1 addition & 1 deletion Ghidra/Features/Base/src/main/java/ghidra/app/services/DataTypeManagerService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ public Archive openArchive(File file, boolean acquireWriteLock)
throws IOException, DuplicateIdException;

/**
* Selects the given data type in the display of data types. A null <tt>dataType</tt>
* Selects the given data type in the display of data types. A null <code>dataType</code>
* value will clear the current selection.
*
* @param dataType The data type to select.
Expand Down
4 changes: 2 additions & 2 deletions Ghidra/Features/Base/src/main/java/ghidra/app/services/DataTypeReferenceFinder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public interface DataTypeReferenceFinder extends ExtensionPoint {
* implementation.
* <p>
* Note that this operation is multi-threaded and that results will be delivered as they
* are found via the <tt>callback</tt>.
* are found via the <code>callback</code>.
*
* @param program the program to search
* @param dataType the type for which to search
Expand All @@ -54,7 +54,7 @@ public void findReferences(Program program, DataType dataType,
* in a manner appropriate with the given implementation.
* <p>
* Note that this operation is multi-threaded and that results will be delivered as they
* are found via the <tt>callback</tt>.
* are found via the <code>callback</code>.
*
* @param program the program to search
* @param composite the type containing the field for which to search
Expand Down
6 changes: 3 additions & 3 deletions Ghidra/Features/Base/src/main/java/ghidra/app/services/GoToService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public interface GoToService {
* overloaded version of {@link #goTo(Address)} uses the given program as the program
* within which to perform the GoTo. If the given program does not contain the given
* address, then the GoTo will not be performed and false will be returned. Passing
* <tt>null</tt> as the <tt>program</tt> parameter will cause this method to attempt to find
* <code>null</code> as the <code>program</code> parameter will cause this method to attempt to find
* a program that contains the given ProgramLocation.
*
* @param loc location to go to
Expand Down Expand Up @@ -91,8 +91,8 @@ public boolean goTo(Navigatable navigatable, Program program, Address address,
* Generates a GoTo event to the gotoAddress. This overloaded version of
* {@link #goTo(Address)} uses the given program as the program within which to
* perform the GoTo. If the given program does not contain the given address, then the
* GoTo will not be performed and false will be returned. Passing <tt>null</tt> as the
* <tt>program</tt> parameter will cause this method to attempt to find
* GoTo will not be performed and false will be returned. Passing <code>null</code> as the
* <code>program</code> parameter will cause this method to attempt to find
* a program that contains the given ProgramLocation.
*
* @param goToAddress the address to goto
Expand Down
2 changes: 1 addition & 1 deletion Ghidra/Features/Base/src/main/java/ghidra/app/services/MarkerService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* the marker/bar will be displayed on the top. Areas will always be lower than
* marker priorities.
* </p>
* <a name="usage"></a>
* <a id="usage"></a>
* <u>Recommended Usage</u><br>
* The service used to work independent of {@link Program}s. In order to work effectively this
* service has been changed to associate created markers with individual programs. Thus, it is
Expand Down
2 changes: 1 addition & 1 deletion Ghidra/Features/Base/src/main/java/ghidra/app/util/ToolTipUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ private ToolTipUtils() {
}

/**
* Examines the give <tt>dataType</tt> and creates a tool tip for it,
* Examines the give <code>dataType</code> and creates a tool tip for it,
* depending upon its actual class type.
*
* @param dataType The data type from which a tool tip will be
Expand Down
24 changes: 12 additions & 12 deletions Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/GhidraRandomAccessFile.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,25 +57,25 @@ private void checkOpen() throws IOException {
* but adds buffering to limit the amount.
* <p>
*
* <a name="mode"></a><p> The <tt>mode</tt> argument specifies the access mode
* <a id="mode"></a><p> The <code>mode</code> argument specifies the access mode
* in which the file is to be opened. The permitted values and their
* meanings are:
*
* <blockquote><table summary="Access mode permitted values and meanings">
* <tr><th><p align="left">Value</p></th><th><p align="left">Meaning</p></th></tr>
* <tr><td valign="top"><tt>"r"</tt></td>
* <td> Open for reading only. Invoking any of the <tt>write</tt>
* <blockquote><table><caption style="visibility:hidden;font-size:0px">Access mode permitted values and meanings</caption>
* <tr><th><p style="text-align:left">Value</p></th><th><p style="text-align:left">Meaning</p></th></tr>
* <tr><td style="vertical-align:top"><code>"r"</code></td>
* <td> Open for reading only. Invoking any of the <code>write</code>
* methods of the resulting object will cause an {@link
* java.io.IOException} to be thrown. </td></tr>
* <tr><td valign="top"><tt>"rw"</tt></td>
* <tr><td style="vertical-align:top"><code>"rw"</code></td>
* <td> Open for reading and writing. If the file does not already
* exist then an attempt will be made to create it. </td></tr>
* <tr><td valign="top"><tt>"rws"</tt></td>
* <td> Open for reading and writing, as with <tt>"rw"</tt>, and also
* <tr><td style="vertical-align:top"><code>"rws"</code></td>
* <td> Open for reading and writing, as with <code>"rw"</code>, and also
* require that every update to the file's content or metadata be
* written synchronously to the underlying storage device. </td></tr>
* <tr><td valign="top"><tt>"rwd"&nbsp;&nbsp;</tt></td>
* <td> Open for reading and writing, as with <tt>"rw"</tt>, and also
* <tr><td style="vertical-align:top"><code>"rwd"&nbsp;&nbsp;</code></td>
* <td> Open for reading and writing, as with <code>"rw"</code>, and also
* require that every update to the file's content be written
* synchronously to the underlying storage device. </td></tr>
* </table></blockquote>
Expand All @@ -84,8 +84,8 @@ private void checkOpen() throws IOException {
* @param mode the access mode, as described
* <a href="#mode">above</a>
* @exception IllegalArgumentException if the mode argument is not equal
* to one of <tt>"r"</tt>, <tt>"rw"</tt>, <tt>"rws"</tt>, or
* <tt>"rwd"</tt>
* to one of <code>"r"</code>, <code>"rw"</code>, <code>"rws"</code>, or
* <code>"rwd"</code>
* @exception FileNotFoundException
* that name cannot be created, or if some other error occurs
* while opening or creating the file
Expand Down
2 changes: 1 addition & 1 deletion Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ public synchronized void enableOverwriteOnConflict(boolean enabled) {

/**
* This method can be used to enable recursive processing of files during
* <tt>-import</tt> or <tt>-process</tt> modes. In order for recursive processing of files to
* <code>-import</code> or <code>-process</code> modes. In order for recursive processing of files to
* occur, the user must have specified a directory (and not a specific file)
* for the Headless Analyzer to import or process.
*
Expand Down
20 changes: 10 additions & 10 deletions Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessScript.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,28 +35,28 @@ public abstract class HeadlessScript extends GhidraScript {
*/
public enum HeadlessContinuationOption {
/**
* Continue running scripts and/or analysis; <tt>-import</tt> and <tt>-process</tt>
* Continue running scripts and/or analysis; <code>-import</code> and <code>-process</code>
* modes complete normally.
*/
CONTINUE,

/**
* Continue running scripts and/or analysis;
* <tt>-import</tt> mode does not save program,
* <tt>-process</tt> mode deletes program.
* <code>-import</code> mode does not save program,
* <code>-process</code> mode deletes program.
*/
CONTINUE_THEN_DELETE,

/**
* Abort any scripts or analysis that come after this script;
* <tt>-import</tt> mode does not save program, <tt>-process</tt> mode deletes program.
* <code>-import</code> mode does not save program, <code>-process</code> mode deletes program.
*/
ABORT_AND_DELETE,

/**
* Abort any scripts or analysis that come after this script; <tt>-import</tt> mode does
* Abort any scripts or analysis that come after this script; <code>-import</code> mode does
* save program (but it may not be processed completely),
* <tt>-process</tt> mode completes normally, minus scripts or analysis that
* <code>-process</code> mode completes normally, minus scripts or analysis that
* runs after the ABORT request.
*/
ABORT
Expand Down Expand Up @@ -285,7 +285,7 @@ public boolean isImporting() throws ImproperUseException {
* </pre>
*
* Then the following usage would ensure that any files imported after this call would
* be saved in the <tt>MyGhidraProject:/dir1/innerDir2</tt> folder.
* be saved in the <code>MyGhidraProject:/dir1/innerDir2</code> folder.
* <pre>
* setHeadlessImportDirectory("dir1/innerDir2");
* </pre>
Expand Down Expand Up @@ -330,8 +330,8 @@ public boolean isImporting() throws ImproperUseException {
* If a file with the same name already exists in the desired location, it will only be
* overwritten if "-overwrite" is true.
* <p>
* This method is only applicable when using the HeadlessAnalyzer <tt>-import</tt> mode and
* is ineffective in <tt>-process</tt> mode.
* This method is only applicable when using the HeadlessAnalyzer <code>-import</code> mode and
* is ineffective in <code>-process</code> mode.
*
* @param importDir the absolute path (relative to root) where inputs will be saved
* @throws ImproperUseException if not in headless mode or headless instance not set
Expand Down Expand Up @@ -372,7 +372,7 @@ public void setHeadlessImportDirectory(String importDir) throws ImproperUseExcep
* <p>
* Analysis will time out only in the case where:
* <ol>
* <li>the users has set an analysis timeout period using the <tt>-analysisTimeoutPerFile</tt>
* <li>the users has set an analysis timeout period using the <code>-analysisTimeoutPerFile</code>
* parameter</li>
* <li>analysis is enabled and has completed</li>
* <li>the current script is being run as a postScript (since postScripts run after
Expand Down
4 changes: 2 additions & 2 deletions Ghidra/Features/Base/src/main/java/ghidra/app/util/navigation/GoToQuery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,9 +559,9 @@ private void notifyListener(boolean hasData) {
//==================================================================================================

/**
* A class to maintain our collection of open programs and to provide an <tt>Iterator</tt>
* A class to maintain our collection of open programs and to provide an <code>Iterator</code>
* when we need to process the collection. The {@link #iterator()} method has a side-effect
* of putting the current program at the front of the <tt>Iterator</tt> so that the current
* of putting the current program at the front of the <code>Iterator</code> so that the current
* program is always searched first when processing the collection of programs.
*/
protected class ProgramGroup implements Iterable<Program> {
Expand Down
2 changes: 1 addition & 1 deletion Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/BoundedBufferedReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ private void fill() throws IOException {
* Reads a single character.
*
* @return The character read, as an integer in the range 0 to 65535 (
* <tt>0x00-0xffff</tt>), or -1 if the end of the stream has been
* <code>0x00-0xffff</code>), or -1 if the end of the stream has been
* reached
* @exception IOException
* If an I/O error occurs
Expand Down
2 changes: 1 addition & 1 deletion Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FieldMouseHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public interface FieldMouseHandler {
* @param mouseEvent The mouse event that triggered the click
* @param serviceProvider A service provider used to access system resources.
* @return true if this handler wishes to have exclusive handling rights to processing the
* <tt>clickedObject</tt>
* <code>clickedObject</code>
* @see ListingField#getClickedObject(ghidra.util.bean.field.FieldLocation)
*/
public boolean fieldElementClicked(Object clickedObject, Navigatable sourceNavigatable,
Expand Down
6 changes: 3 additions & 3 deletions Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRL.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@
* Examples (pipes shown in red since they are hard to see):
* <ul>
* <li><b>file://dir/subdir</b> -- simplest example, locates a file on local computer filesystem.
* <li><b>file://dir/subdir/example.zip<font color="red">|</font>zip://readme.txt</b> -- points to a file named "readme.txt" in a zip file.
* <li><b>file://dir/subdir/example.zip<font color="red">|</font>zip://dir/nested.tar<font color="red">|</font>tar://file.txt</b> -- points to
* <li><b>file://dir/subdir/example.zip<span style="color:red">|</span>zip://readme.txt</b> -- points to a file named "readme.txt" in a zip file.
* <li><b>file://dir/subdir/example.zip<span style="color:red">|</span>zip://dir/nested.tar<span style="color:red">|</span>tar://file.txt</b> -- points to
* a file inside a TAR archive, which is inside a ZIP archive, which is on the local filesystem.
* <li><b>file://dir/subdir/example.zip?MD5=1234567<font color="red">|</font>zip://readme.txt?MD5=987654</b> --
* <li><b>file://dir/subdir/example.zip?MD5=1234567<span style="color:red">|</span>zip://readme.txt?MD5=987654</b> --
* points to a file named "readme.txt" (with a MD5 hash) in a zip file (that has another
* MD5 hash).
* </ul>
Expand Down
10 changes: 5 additions & 5 deletions Ghidra/Features/Base/src/main/java/ghidra/program/flatapi/FlatProgramAPI.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@ public final Address find(Address start, byte[] values) {
* starting from the address. If the start address is null, then the find will start
* from the minimum address of the program.
* <p>
* The <tt>byteString</tt> may contain regular expressions. The following
* The <code>byteString</code> may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
* <pre>
* "\\x80" - A basic search pattern for a byte value of 0x80
Expand Down Expand Up @@ -629,7 +629,7 @@ public final Address findBytes(Address start, String byteString) {
* the given byte string, starting from the address. If the start address is null, then the
* find will start from the minimum address of the program.
* <p>
* The <tt>byteString</tt> may contain regular expressions. The following
* The <code>byteString</code> may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
* <pre>
* "\\x80" - A basic search pattern for a byte value of 0x80
Expand All @@ -655,7 +655,7 @@ public final Address[] findBytes(Address start, String byteString, int matchLimi
* the given byte string, starting from the address. If the start address is null, then the
* find will start from the minimum address of the program.
* <p>
* The <tt>byteString</tt> may contain regular expressions. The following
* The <code>byteString</code> may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
* <pre>
* "\\x80" - A basic search pattern for a byte value of 0x80
Expand Down Expand Up @@ -699,7 +699,7 @@ public final Address[] findBytes(Address start, String byteString, int matchLimi
*
* Note: The ranges within the addressSet are NOT treated as a contiguous set when searching
* <p>
* The <tt>byteString</tt> may contain regular expressions. The following
* The <code>byteString</code> may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
* <pre>
* "\\x80" - A basic search pattern for a byte value of 0x80
Expand Down Expand Up @@ -731,7 +731,7 @@ public final Address[] findBytes(AddressSetView set, String byteString, int matc
* treated as a contiguous set when searching.
*
* <p>
* The <tt>byteString</tt> may contain regular expressions. The following
* The <code>byteString</code> may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
* <pre>
* "\\x80" - A basic search pattern for a byte value of 0x80
Expand Down
Loading