aboutsummaryrefslogtreecommitdiff
path: root/gdb/doc
diff options
context:
space:
mode:
authorAndrew Burgess <aburgess@redhat.com>2023-03-02 13:10:08 +0000
committerAndrew Burgess <aburgess@redhat.com>2023-05-12 18:24:24 +0100
commit773e2d29c3a3c0f068b188a2a93c269cdfb237ad (patch)
tree32b1ef9cf74a2bca2d0b33064225f4ea9586ba1e /gdb/doc
parenta68f7e9844208ad8cd498f89b5100084ece7d0f6 (diff)
downloadgdb-773e2d29c3a3c0f068b188a2a93c269cdfb237ad.zip
gdb-773e2d29c3a3c0f068b188a2a93c269cdfb237ad.tar.gz
gdb-773e2d29c3a3c0f068b188a2a93c269cdfb237ad.tar.bz2
gdb/doc: improve Python Disassembler API documentation
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.
Diffstat (limited to 'gdb/doc')
-rw-r--r--gdb/doc/python.texi17
1 files changed, 12 insertions, 5 deletions
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 7c3a3cc..1113591 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -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