mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-09 02:36:01 +02:00
Code Issues Wiki Activity

Bug 303315: Improve javadoc for disassembly service

Browse source
This commit is contained in:
John Cortell 2010-05-28 18:32:07 +00:00
parent ab8c900a86
commit 54d5da166c
1 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/debug/service/IDisassembly.java
View file

@ -26,7 +26,7 @@ public interface IDisassembly extends IDsfService {
public interface IDisassemblyDMContext extends IDMContext {} public interface IDisassemblyDMContext extends IDMContext {}
/** /**
* Gets a block of disassembled code given an address range. * Gets a block of disassembled code given an address range.
* *
* @param context * @param context
@ -35,10 +35,12 @@ public interface IDisassembly extends IDsfService {
* Beginning address, inclusive. If null, disassemble from the * Beginning address, inclusive. If null, disassemble from the
* instruction pointer. * instruction pointer.
* @param endAddress * @param endAddress
* End address, exclusive. * End address, exclusive. If null, implementation should attempt
* to disassemble some reasonable, default number of
* instructions. That default is implementation specific.
* @param drm * @param drm
* Disassembled code * Disassembled code
*/ */
public void getInstructions( public void getInstructions(
IDisassemblyDMContext context, IDisassemblyDMContext context,
BigInteger startAddress, BigInteger startAddress,
@ -57,9 +59,10 @@ public interface IDisassembly extends IDsfService {
* Starting point. 1-based line number within the file. If the * Starting point. 1-based line number within the file. If the
* line does not represent compiled code, disassembly will start * line does not represent compiled code, disassembly will start
* at the first subsequent line that does. * at the first subsequent line that does.
* @param lines * @param instructionCount
* Number of lines of disassembled code to produce. -1 means all. * Number of instructions to disassemble. -1 means all
* * available instructions (starting at [linenum])
*
* @param drm * @param drm
* Disassembled code * Disassembled code
*/ */
@ -67,7 +70,7 @@ public interface IDisassembly extends IDsfService {
IDisassemblyDMContext context, IDisassemblyDMContext context,
String filename, String filename,
int linenum, int linenum,
int lines, int instrtuctionCount,
DataRequestMonitor<IInstruction[]> drm); DataRequestMonitor<IInstruction[]> drm);
/** /**
@ -100,8 +103,9 @@ public interface IDisassembly extends IDsfService {
* Starting point. 1-based line number within the file. If the * Starting point. 1-based line number within the file. If the
* line does not represent compiled code, disassembly will start * line does not represent compiled code, disassembly will start
* at the first subsequent line that does. * at the first subsequent line that does.
* @param lines * @param instructionCount
* Number of lines of disassembled code to produce. -1 means all. * Number of instructions to disassemble. -1 means all
* available instructions (starting at [linenum])
* @param drm * @param drm
* Disassembled code * Disassembled code
*/ */
@ -109,7 +113,7 @@ public interface IDisassembly extends IDsfService {
IDisassemblyDMContext context, IDisassemblyDMContext context,
String filename, String filename,
int linenum, int linenum,
int lines, int instructionCount,
DataRequestMonitor<IMixedInstruction[]> drm); DataRequestMonitor<IMixedInstruction[]> drm);
} }