mirror of
https://github.com/NationalSecurityAgency/ghidra.git
synced 2025-10-05 02:39:44 +02:00
javadoc html5
This commit is contained in:
astrelsky
parent
3eb130123b
commit
3bdf049d44
136 changed files with 428 additions and 425 deletions
|
|
@ -26,13 +26,13 @@ import ghidra.util.exception.*;
|
|||
/**
|
||||
* A class to hold utility methods for working with namespaces.
|
||||
* <p>
|
||||
* <a name="examples"></a>
|
||||
* <a id="examples"></a>
|
||||
* Example string format:
|
||||
* <ul>
|
||||
* <li>global{@link Namespace#NAMESPACE_DELIMITER ::}child1{@link Namespace#NAMESPACE_DELIMITER ::}child2
|
||||
* <li>child1
|
||||
* </ul>
|
||||
* <a name="assumptions"></a>
|
||||
* <a id="assumptions"></a>
|
||||
* <b>Assumptions for creating namespaces from a path string: </b>
|
||||
* <ul>
|
||||
* <li>All elements of a namespace path should be namespace symbols and not other
|
||||
|
|
|
|||
|
|
@ -68,10 +68,10 @@ public interface AddressMap {
|
|||
* @param keyRangeList
|
||||
* @param addr address or null
|
||||
* @return index of the keyRange within the keyRangeList which contains addr
|
||||
* if it is contained in the list; otherwise, <tt>(-(<i>insertion point</i>) - 1)</tt>.
|
||||
* if it is contained in the list; otherwise, <code>(-(<i>insertion point</i>) - 1)</code>.
|
||||
* The <i>insertion point</i> is defined as the point at which the
|
||||
* addr would be inserted into the list: the index of the first keyRange
|
||||
* greater than addr, or <tt>keyRangeList.size()</tt>, if all
|
||||
* greater than addr, or <code>keyRangeList.size()</code>, if all
|
||||
* keyRanges in the list are less than the specified addr. Note
|
||||
* that this guarantees that the return value will be >= 0 if
|
||||
* and only if the addr is found within a keyRange.
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ public interface ArrayStringable extends DataType {
|
|||
/**
|
||||
* For cases where an array of this type exists, get the appropriate string to use as the
|
||||
* default label prefix, taking into account the fact that there exists a reference to the
|
||||
* data that references <tt>offcutLength</tt> bytes into this type
|
||||
* data that references <code>offcutLength</code> bytes into this type
|
||||
*
|
||||
* @param buf memory buffer containing the bytes.
|
||||
* @param settings the Settings object.
|
||||
|
|
|
|||
|
|
@ -230,7 +230,7 @@ public interface DataType {
|
|||
/**
|
||||
* Returns the appropriate string to use as the default label prefix, taking into account
|
||||
* the fact that there exists a reference to the data that references
|
||||
* <tt>offcutLength</tt> bytes into this type
|
||||
* <code>offcutLength</code> bytes into this type
|
||||
*
|
||||
* @param buf memory buffer containing the bytes.
|
||||
* @param settings the Settings object
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ package ghidra.program.model.data;
|
|||
public interface InvalidatedListener {
|
||||
|
||||
/**
|
||||
* Called when the given <tt>dataTypeManager</tt>'s cache has been invalidated.
|
||||
* Called when the given <code>dataTypeManager</code>'s cache has been invalidated.
|
||||
* @param dataTypeManager The manager whose cache has been invalidated.
|
||||
*/
|
||||
public void dataTypeManagerInvalidated(DataTypeManager dataTypeManager);
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ public class StructureFactory {
|
|||
* @return A new structure not yet added to memory.
|
||||
* @throws IllegalArgumentException for the following conditions:
|
||||
* <ul>
|
||||
* <li>if <tt>dataLength</tt> is not greater than zero
|
||||
* <li>if <code>dataLength</code> is not greater than zero
|
||||
* <li>if the number of components to add exceeds the available
|
||||
* address space
|
||||
* <li>if there are any instructions in the provided
|
||||
|
|
@ -72,8 +72,8 @@ public class StructureFactory {
|
|||
* @return A new structure not yet added to memory.
|
||||
* @throws IllegalArgumentException for the following conditions:
|
||||
* <ul>
|
||||
* <li>if <tt>structureName</tt> is <tt>null</tt>
|
||||
* <li>if <tt>dataLength</tt> is not greater than zero
|
||||
* <li>if <code>structureName</code> is <code>null</code>
|
||||
* <li>if <code>dataLength</code> is not greater than zero
|
||||
* <li>if the number of components to add exceeds the available
|
||||
* address space
|
||||
* <li>if there are any instructions in the provided
|
||||
|
|
@ -145,8 +145,8 @@ public class StructureFactory {
|
|||
* @return A new structure not yet added to memory.
|
||||
* @throws IllegalArgumentException for the following conditions:
|
||||
* <ul>
|
||||
* <li>if the component at <tt>fromPath</tt> or the component
|
||||
* at <tt>toPath</tt> are null
|
||||
* <li>if the component at <code>fromPath</code> or the component
|
||||
* at <code>toPath</code> are null
|
||||
* <li>if there is not data to add to the structure
|
||||
* <li>if the parent data type is not a structure
|
||||
* </ul>
|
||||
|
|
@ -175,9 +175,9 @@ public class StructureFactory {
|
|||
* @return A new structure not yet added to memory.
|
||||
* @throws IllegalArgumentException for the following conditions:
|
||||
* <ul>
|
||||
* <li>if <tt>structureName</tt> is <tt>null</tt>
|
||||
* <li>if the component at <tt>fromPath</tt> or the component
|
||||
* at <tt>toPath</tt> are null
|
||||
* <li>if <code>structureName</code> is <code>null</code>
|
||||
* <li>if the component at <code>fromPath</code> or the component
|
||||
* at <code>toPath</code> are null
|
||||
* <li>if there is not data to add to the structure
|
||||
* <li>if the parent data type is not a structure
|
||||
* </ul>
|
||||
|
|
|
|||
|
|
@ -237,7 +237,7 @@ public interface CodeUnit extends MemBuffer {
|
|||
public String[] getCommentAsArray(int commentType);
|
||||
|
||||
/**
|
||||
* Set the comment for the given comment type. Passing <tt>null</tt> clears the comment
|
||||
* Set the comment for the given comment type. Passing <code>null</code> clears the comment
|
||||
*
|
||||
* @param commentType either EOL_COMMENT, PRE_COMMENT,
|
||||
* POST_COMMENT, or REPEATABLE_COMMENT
|
||||
|
|
|
|||
|
|
@ -197,7 +197,7 @@ public interface Listing {
|
|||
* Returns an iterator of the code units in this listing (in proper
|
||||
* sequence), starting at the specified address. The specified address
|
||||
* indicates the first code unit that would be returned by an initial call
|
||||
* to the <tt>next</tt> method. An initial call to the <tt>previous</tt>
|
||||
* to the <code>next</code> method. An initial call to the <code>previous</code>
|
||||
* method would return the code unit with an address less than the specified
|
||||
* address.
|
||||
* <p>
|
||||
|
|
@ -273,7 +273,7 @@ public interface Listing {
|
|||
* Returns an iterator of the instructions in this listing (in proper
|
||||
* sequence), starting at the specified address. The specified address
|
||||
* indicates the first instruction that would be returned by an initial call
|
||||
* to the <tt>next</tt> method. An initial call to the <tt>previous</tt>
|
||||
* to the <code>next</code> method. An initial call to the <code>previous</code>
|
||||
* method would return the instruction with an address less than the
|
||||
* specified address.
|
||||
* <p>
|
||||
|
|
@ -347,8 +347,8 @@ public interface Listing {
|
|||
/**
|
||||
* Returns an iterator of the data in this listing (in proper sequence),
|
||||
* starting at the specified address. The specified address indicates the
|
||||
* first Data that would be returned by an initial call to the <tt>next</tt>
|
||||
* method. An initial call to the <tt>previous</tt> method would return the
|
||||
* first Data that would be returned by an initial call to the <code>next</code>
|
||||
* method. An initial call to the <code>previous</code> method would return the
|
||||
* Data with an address less than the specified address.
|
||||
* <p>
|
||||
*
|
||||
|
|
@ -426,8 +426,8 @@ public interface Listing {
|
|||
* Returns an iterator of the defined data in this listing (in proper
|
||||
* sequence), starting at the specified address. The specified address
|
||||
* indicates the first defined Data that would be returned by an initial
|
||||
* call to the <tt>next</tt> method. An initial call to the
|
||||
* <tt>previous</tt> method would return the defined Data with an address
|
||||
* call to the <code>next</code> method. An initial call to the
|
||||
* <code>previous</code> method would return the defined Data with an address
|
||||
* less than the specified address.
|
||||
* <p>
|
||||
*
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ public interface MemBuffer {
|
|||
}
|
||||
|
||||
/**
|
||||
* Reads <tt>b.length</tt> bytes from this memory buffer
|
||||
* Reads <code>b.length</code> bytes from this memory buffer
|
||||
* starting at the address of this memory buffer plus the given memoryBufferOffset
|
||||
* from that position. The actual number of bytes may be fewer
|
||||
* if bytes can't be read.
|
||||
|
|
|
|||
|
|
@ -245,10 +245,10 @@ public class PcodeDataTypeManager {
|
|||
}
|
||||
|
||||
/**
|
||||
* Generate an XML tag describing the given data-type. Most data-types produce a <type> tag,
|
||||
* fully describing the data-type. Where possible a <typeref> tag is produced, which just gives
|
||||
* Generate an XML tag describing the given data-type. Most data-types produce a {@code <type>} tag,
|
||||
* fully describing the data-type. Where possible a {@code <typeref>} tag is produced, which just gives
|
||||
* the name of the data-type, deferring a full description of the data-type. For certain simple or
|
||||
* nameless data-types, a <type> tag is emitted giving a full description.
|
||||
* nameless data-types, a {@code <type>} tag is emitted giving a full description.
|
||||
* @param type is the data-type to be converted
|
||||
* @param size is the size in bytes of the specific instance of the data-type
|
||||
* @return a StringBuilder containing the XML tag
|
||||
|
|
|
|||
|
|
@ -83,9 +83,9 @@ public class Relocation {
|
|||
}
|
||||
|
||||
/**
|
||||
* The name of the symbol being relocated or <tt>null</tt> if there is no symbol name.
|
||||
* The name of the symbol being relocated or <code>null</code> if there is no symbol name.
|
||||
*
|
||||
* @return the name of the symbol being relocated or <tt>null</tt> if there is no symbol name.
|
||||
* @return the name of the symbol being relocated or <code>null</code> if there is no symbol name.
|
||||
*/
|
||||
public String getSymbolName() {
|
||||
return symbolName;
|
||||
|
|
|
|||
|
|
@ -214,8 +214,8 @@ public class Scalar implements Comparable<Scalar> {
|
|||
}
|
||||
|
||||
/**
|
||||
* <p>Adds the integer n to <tt>this</tt>.
|
||||
* Computes (<tt>this = this + n</tt>).
|
||||
* <p>Adds the integer n to <code>this</code>.
|
||||
* Computes (<code>this = this + n</code>).
|
||||
* @param n the value to add to this scalars value to produce a new scalar.
|
||||
*/
|
||||
public Scalar add(long n) {
|
||||
|
|
@ -279,7 +279,7 @@ public class Scalar implements Comparable<Scalar> {
|
|||
}
|
||||
|
||||
/**
|
||||
* <p>Sets <tt>this = this << n</tt>.</p>
|
||||
* <p>Sets <code>this = this << n</code>.</p>
|
||||
* @param n the number of bits to shift left.
|
||||
* @throws ArithmeticException if n < 0.
|
||||
*/
|
||||
|
|
@ -291,7 +291,7 @@ public class Scalar implements Comparable<Scalar> {
|
|||
}
|
||||
|
||||
/**
|
||||
* <p>Sets <tt>this = this >> n</tt> using 0 as the fill bit.</p>
|
||||
* <p>Sets <code>this = this >> n</code> using 0 as the fill bit.</p>
|
||||
* @param n the number of bits to shift right.
|
||||
* @throws ArithmeticException if n < 0.
|
||||
*/
|
||||
|
|
@ -303,7 +303,7 @@ public class Scalar implements Comparable<Scalar> {
|
|||
}
|
||||
|
||||
/**
|
||||
* <p>Sets <tt>this = this >> n</tt> replicating the sign bit.</p>
|
||||
* <p>Sets <code>this = this >> n</code> replicating the sign bit.</p>
|
||||
* @param n the number of bits to arithmetically shift.
|
||||
* @throws ArithmeticException if n < 0.
|
||||
*/
|
||||
|
|
@ -315,7 +315,7 @@ public class Scalar implements Comparable<Scalar> {
|
|||
}
|
||||
|
||||
/**
|
||||
* <p>Sets <tt>this = this - n</tt>.</p>
|
||||
* <p>Sets <code>this = this - n</code>.</p>
|
||||
* @param n the value to subtract from this scalar to produce a new scalar.
|
||||
*/
|
||||
public Scalar subtract(long n) {
|
||||
|
|
|
|||
|
|
@ -113,7 +113,7 @@ public interface Symbol {
|
|||
/**
|
||||
* Returns all memory references to the address of this symbol. If you do not have a
|
||||
* {@link TaskMonitor} instance, then you can pass {@link TaskMonitorAdapter#DUMMY_MONITOR} or
|
||||
* <tt>null</tt>.
|
||||
* <code>null</code>.
|
||||
*
|
||||
* @return all memory references to the address of this symbol.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1021,7 +1021,7 @@ public class SymbolUtilities {
|
|||
|
||||
/**
|
||||
* Returns a comparator for symbols. The comparison is based upon the name. This call
|
||||
* replaces the former <tt>compareTo</tt> method on Symbol. This comparator returned here
|
||||
* replaces the former <code>compareTo</code> method on Symbol. This comparator returned here
|
||||
* is case-insensitive.
|
||||
*
|
||||
* @return the comparator
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ public class PlateFieldLocation extends CommentFieldLocation {
|
|||
* @param charOffset the character position on the row of the location.
|
||||
* @param comment plate comment text
|
||||
* @param commentRow The row index into the comments of this location. This is different
|
||||
* than the <tt>row</tt> due to the fact that the PlateField has fictitious borders
|
||||
* than the <code>row</code> due to the fact that the PlateField has fictitious borders
|
||||
* that don't exist in the actual comment.
|
||||
*/
|
||||
public PlateFieldLocation(Program program, Address addr, int[] componentPath, int row,
|
||||
|
|
@ -76,7 +76,7 @@ public class PlateFieldLocation extends CommentFieldLocation {
|
|||
|
||||
/**
|
||||
* Returns the index into the String[] returned by {@link #getComment()} that represents
|
||||
* the comment row that was clicked. <tt>-1</tt> will be returned if the border of the
|
||||
* the comment row that was clicked. <code>-1</code> will be returned if the border of the
|
||||
* plate field was clicked.
|
||||
* <p>
|
||||
* <b>Note: </b> This value is different than that returned by {@link #getRow()}, as that
|
||||
|
|
@ -84,7 +84,7 @@ public class PlateFieldLocation extends CommentFieldLocation {
|
|||
* decoration to the comments, which causes the screen row to differ from the comment
|
||||
* row.
|
||||
* @return the index into the String[] returned by {@link #getComment()} that represents
|
||||
* the comment row that was clicked. <tt>-1</tt> will be returned if the border of the
|
||||
* the comment row that was clicked. <code>-1</code> will be returned if the border of the
|
||||
* plate field was clicked.
|
||||
*/
|
||||
public int getCommentRow() {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue