diff options
| author | Jordan Wiens <github@psifertex.com> | 2019-07-24 13:44:53 -0400 |
|---|---|---|
| committer | Jordan Wiens <github@psifertex.com> | 2019-07-24 13:44:53 -0400 |
| commit | ede41e0ceb67494371030fbd5041852bf1900fdf (patch) | |
| tree | 64a40a296e90ce2a9ba9b3cb20424854e900bf70 /python | |
| parent | 16d6fc70bfbc47ccf1b3410c3762830ad09f1fc5 (diff) | |
small documentation improvements
Diffstat (limited to 'python')
| -rw-r--r-- | python/binaryview.py | 12 | ||||
| -rw-r--r-- | python/datarender.py | 5 |
2 files changed, 10 insertions, 7 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index 179d0d21..a88d1dd1 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -2739,10 +2739,14 @@ class BinaryView(object): def get_functions_at(self, addr): """ - ``get_functions_at`` get a list of binaryninja.Function objects (one for each valid plat) at the given - virtual address. Binary Ninja does not limit the number of platforms in a given file thus there may be multiple - functions defined from different architectures at the same location. This API allows you to query all of valid - platforms. + + ``get_functions_at`` get a list of binaryninja.Function objects (one for each valid platform) that start at the + given virtual address. Binary Ninja does not limit the number of platforms in a given file thus there may be + multiple functions defined from different architectures at the same location. This API allows you to query all + of valid platforms. + + You may also be interested in :func:`get_functions_containing` which is useful for requesting all function + that contain a given address :param int addr: virtual address of the desired Function object list. :return: a list of binaryninja.Function objects defined at the provided virtual address diff --git a/python/datarender.py b/python/datarender.py index efcaf606..0aaa81a7 100644 --- a/python/datarender.py +++ b/python/datarender.py @@ -54,18 +54,17 @@ class DataRenderer(object): class BarDataRenderer(DataRenderer): def __init__(self): DataRenderer.__init__(self) - def perform_is_valid_for_data(self, ctxt, view, addr, type, context): return DataRenderer.is_type_of_struct_name(type, "BAR", context) - def perform_get_lines_for_data(self, ctxt, view, addr, type, prefix, width, context): prefix.append(InstructionTextToken(InstructionTextTokenType.TextToken, "I'm in ur BAR")) return [DisassemblyTextLine(prefix, addr)] - def __del__(self): pass BarDataRenderer().register_type_specific() + + Note that the formatting is sub-optimal to work around an issue with Sphinx and reStructured text """ _registered_renderers = [] |
