Imagelibrary/binutils-gdb
1
0
Fork 1
mirror of https://github.com/bminor/binutils-gdb.git synced 2025-12-26 01:07:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

gdb/doc: improve Python Disassembler API documentation

Browse Source 
Some small improvements to the Python Disassembler API documentation:

  * Be consistent about using the package scope in the @deftp lines,

  * Rework the description of the DisassemblerResult class to include
    mention of builtin_disassemble.
This commit is contained in:
Andrew Burgess
2023-03-02 13:10:08 +00:00
parent a68f7e9844
commit 773e2d29c3
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
gdb/doc/python.texi
View File

@@ -6973,7 +6973,8 @@ back and be re-raised by @code{builtin_disassemble}.
@end defun
@end deftp
@deftp {class} Disassembler
@anchor{Disassembler Class}
@deftp {class} gdb.disassembler.Disassembler
This is a base class from which all user implemented disassemblers
must inherit.
@@ -7023,10 +7024,16 @@ the error stream according to the @kbd{set python print-stack} setting
@end defun
@end deftp
@deftp {class} DisassemblerResult
This class is used to hold the result of calling
@w{@code{Disassembler.__call__}}, and represents a single disassembled
instruction. This class has the following properties and methods:
@deftp {class} gdb.disassembler.DisassemblerResult
This class represents the result of disassembling a single
instruction. An instance of this class will be returned from
@code{builtin_disassemble} (@pxref{builtin_disassemble}), and an
instance of this class should be returned from
@w{@code{Disassembler.__call__}} (@pxref{Disassembler Class}) if an
instruction was successfully disassembled.
The @code{DisassemblerResult} class has the following properties and
methods:
@defun DisassemblerResult.__init__ (length, string)
Initialize an instance of this class, @var{length} is the length of