diff options
Diffstat (limited to 'python/binaryview.py')
| -rw-r--r-- | python/binaryview.py | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index 042c08f5..8165c592 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -1,4 +1,4 @@ -# Copyright (c) 2015-2016 Vector 35 LLC +# Copyright (c) 2015-2017 Vector 35 LLC # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to @@ -641,7 +641,7 @@ class BinaryView(object): @classmethod def set_default_session_data(cls, name, value): """ - ```set_default_session_data``` saves a variable to the BinaryView. + ``set_default_session_data`` saves a variable to the BinaryView. :param name: name of the variable to be saved :param value: value of the variable to be saved @@ -1329,7 +1329,7 @@ class BinaryView(object): def perform_is_offset_executable(self, addr): """ - ``perform_is_offset_writable`` implements a check if a virtual address ``addr`` is executable. + ``perform_is_offset_executable`` implements a check if a virtual address ``addr`` is executable. .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide data without overriding this method. @@ -1410,7 +1410,7 @@ class BinaryView(object): def create_database(self, filename, progress_func=None): """ - ``perform_get_database`` writes the current database (.bndb) file out to the specified file. + ``create_database`` writes the current database (.bndb) file out to the specified file. :param str filename: path and filename to write the bndb to, this string `should` have ".bndb" appended to it. :param callable() progress_func: optional function to be called with the current progress and total count. @@ -1851,7 +1851,7 @@ class BinaryView(object): def define_user_data_var(self, addr, var_type): """ - ``define_data_var`` defines a user data variable ``var_type`` at the virtual address ``addr``. + ``define_user_data_var`` defines a user data variable ``var_type`` at the virtual address ``addr``. :param int addr: virtual address to define the given data variable :param binaryninja.Type var_type: type to be defined at the given virtual address @@ -1881,7 +1881,7 @@ class BinaryView(object): def undefine_user_data_var(self, addr): """ - ``undefine_data_var`` removes the user data variable at the virtual address ``addr``. + ``undefine_user_data_var`` removes the user data variable at the virtual address ``addr``. :param int addr: virtual address to define the data variable to be removed :rtype: None @@ -2145,6 +2145,8 @@ class BinaryView(object): """ ``define_auto_symbol`` adds a symbol to the internal list of automatically discovered Symbol objects. + .. warning:: If multiple symbols for the same address are defined, only the most recent symbol will ever be used. + :param Symbol sym: the symbol to define :rtype: None """ @@ -2154,6 +2156,8 @@ class BinaryView(object): """ ``define_auto_symbol_and_var_or_function`` + .. warning:: If multiple symbols for the same address are defined, only the most recent symbol will ever be used. + :param Symbol sym: the symbol to define :param SymbolType sym_type: Type of symbol being defined :param Platform plat: (optional) platform @@ -2180,6 +2184,8 @@ class BinaryView(object): """ ``define_user_symbol`` adds a symbol to the internal list of user added Symbol objects. + .. warning:: If multiple symbols for the same address are defined, only the most recent symbol will ever be used. + :param Symbol sym: the symbol to define :rtype: None """ |