diff options
Diffstat (limited to 'python/function.py')
| -rw-r--r-- | python/function.py | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/python/function.py b/python/function.py index 4c1d1478..4161d45c 100644 --- a/python/function.py +++ b/python/function.py @@ -938,8 +938,8 @@ class Function(object): :param TagType type: The Tag Type for this Tag :param str data: Additional data for the Tag - :return The created Tag - :rtype Tag + :return: The created Tag + :rtype: Tag :Example: >>> tt = bv.tag_types["Crabby Functions"] @@ -955,7 +955,7 @@ class Function(object): ``address_tags`` gets a list of all address Tags in the function. Tags are returned as a list of (arch, address, Tag) tuples. - :type [(Architecture, int, Tag)] + :rtype: list((Architecture, int, Tag)) """ count = ctypes.c_ulonglong() tags = core.BNGetAddressTagReferences(self.handle, count) @@ -973,8 +973,8 @@ class Function(object): :param int addr: Address to get tags at :param Architecture arch: Architecture for the block in which the Tag is added (optional) - :return A list of Tags - :rtype [Tag] + :return: A list of Tags + :rtype: list(Tag) """ if arch is None: arch = self.arch @@ -994,7 +994,7 @@ class Function(object): :param int addr: Address at which to add the tag :param Tag tag: Tag object to be added :param Architecture arch: Architecture for the block in which the Tag is added (optional) - :rtype None + :rtype: None """ if arch is None: arch = self.arch @@ -1010,8 +1010,8 @@ class Function(object): :param str data: Additional data for the Tag :param bool unique: If a tag already exists at this location with this data, don't add another :param Architecture arch: Architecture for the block in which the Tag is added (optional) - :return The created Tag - :rtype Tag + :return: The created Tag + :rtype: Tag """ if arch is None: arch = self.arch @@ -1033,7 +1033,7 @@ class Function(object): :param int addr: Address at which to add the tag :param Tag tag: Tag object to be added :param Architecture arch: Architecture for the block in which the Tag is added (optional) - :rtype None + :rtype: None """ if arch is None: arch = self.arch @@ -1046,7 +1046,7 @@ class Function(object): :param int addr: Address at which to add the tag :param Tag tag: Tag object to be added :param Architecture arch: Architecture for the block in which the Tag is added (optional) - :rtype None + :rtype: None """ if arch is None: arch = self.arch @@ -1061,8 +1061,8 @@ class Function(object): :param str data: Additional data for the Tag :param bool unique: If a tag already exists at this location with this data, don't add another :param Architecture arch: Architecture for the block in which the Tag is added (optional) - :return The created Tag - :rtype Tag + :return: The created Tag + :rtype: Tag """ if arch is None: arch = self.arch @@ -1083,7 +1083,7 @@ class Function(object): :param int addr: Address at which to add the tag :param Tag tag: Tag object to be added :param Architecture arch: Architecture for the block in which the Tag is added (optional) - :rtype None + :rtype: None """ if arch is None: arch = self.arch @@ -1094,7 +1094,7 @@ class Function(object): """ ``function_tags`` gets a list of all function Tags for the function. - :type [Tag] + :rtype: list(Tag) """ count = ctypes.c_ulonglong() tags = core.BNGetFunctionTags(self.handle, count) @@ -1110,7 +1110,7 @@ class Function(object): Since this adds a user tag, it will be added to the current undo buffer. :param Tag tag: Tag object to be added - :rtype None + :rtype: None """ core.BNAddUserFunctionTag(self.handle, tag.handle) @@ -1122,8 +1122,8 @@ class Function(object): :param TagType type: Tag Type for the Tag that is created :param str data: Additional data for the Tag :param bool unique: If a tag already exists with this data, don't add another - :return The created Tag - :rtype Tag + :return: The created Tag + :rtype: Tag """ if unique: for tag in self.function_tags: @@ -1140,7 +1140,7 @@ class Function(object): Since this removes a user tag, it will be added to the current undo buffer. :param Tag tag: Tag object to be added - :rtype None + :rtype: None """ core.BNRemoveUserFunctionTag(self.handle, tag.handle) @@ -1149,7 +1149,7 @@ class Function(object): ``add_user_function_tag`` adds an already-created Tag object as a function tag. :param Tag tag: Tag object to be added - :rtype None + :rtype: None """ core.BNAddAutoFunctionTag(self.handle, tag.handle) @@ -1160,8 +1160,8 @@ class Function(object): :param TagType type: Tag Type for the Tag that is created :param str data: Additional data for the Tag :param bool unique: If a tag already exists with this data, don't add another - :return The created Tag - :rtype Tag + :return: The created Tag + :rtype: Tag """ if unique: for tag in self.function_tags: @@ -1177,7 +1177,7 @@ class Function(object): ``remove_user_function_tag`` removes a Tag object as a function tag. :param Tag tag: Tag object to be added - :rtype None + :rtype: None """ core.BNRemoveAutoFunctionTag(self.handle, tag.handle) @@ -1695,7 +1695,7 @@ class Function(object): :param Architecture arch: (optional) Architecture for the given function :rtype: binaryninja.function.RegisterValue - .. note:: Stack base is zero on entry into the function unless the architecture places the return address on the + .. note:: Stack base is zero on entry into the function unless the architecture places the return address on the \ stack as in (x86/x86_64) where the stack base will start at address_size :Example: |