diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2019-09-30 11:08:59 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2019-09-30 11:08:59 -0400 |
| commit | ab5327e541c7a335ce89fbdb63126e1222346542 (patch) | |
| tree | 4718bab8de2a8df728ad5b69ac292282265f1c90 /python/typelibrary.py | |
| parent | 51510e08a9aeb2b8b23124131679ff89b2cb7f73 (diff) | |
include more tag documentation references to other APIs, fix cross-module doc linking and other small formatting cleanups
Diffstat (limited to 'python/typelibrary.py')
| -rw-r--r-- | python/typelibrary.py | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/python/typelibrary.py b/python/typelibrary.py index d4e5b0a2..6463590e 100644 --- a/python/typelibrary.py +++ b/python/typelibrary.py @@ -53,8 +53,8 @@ class TypeLibrary(object): Creates an empty type library object with a random GUID and the provided name. - :param Architecture arch - :param str name + :param Architecture arch: + :param str name: :rtype: TypeLibrary """ handle = core.BNNewTypeLibrary(arch.handle, name) @@ -65,7 +65,7 @@ class TypeLibrary(object): """ Loads a finalized type library instance from file - :param str path + :param str path: :rtype: TypeLibrary """ handle = core.BNLoadTypeLibraryFromFile(path) @@ -77,7 +77,7 @@ class TypeLibrary(object): """ Saves a finalized type library instance to file - :param str path + :param str path: :rtype: None """ core.BNWriteTypeLibraryToFile(self.handle, path) @@ -88,8 +88,8 @@ class TypeLibrary(object): `from_name` looks up the first type library found with a matching name. Keep in mind that names are not necessarily unique. - :param Architecture arch - :param str name + :param Architecture arch: + :param str name: :rtype: TypeLibrary """ handle = core.BNLookupTypeLibraryByName(arch.handle, name) @@ -103,8 +103,8 @@ class TypeLibrary(object): `from_guid` attempts to grab a type library associated with the provided Architecture and GUID pair - :param Architecture arch - :param str guid + :param Architecture arch: + :param str guid: :rtype: TypeLibrary """ handle = core.BNLookupTypeLibraryByGuid(arch.handle, guid) @@ -276,11 +276,11 @@ class TypeLibrary(object): through NamedTypeReferences are already appropriately prepared. To add types and objects from an existing BinaryView, it is recommended to use - :py:meth:`BinaryView.export_object_to_library`, which will automatically pull in + :py:meth:`export_object_to_library <binaryninja.binaryview.BinaryView.export_object_to_library>`, which will automatically pull in all referenced types and record additional dependencies as needed. - :param QualifiedName name - :param Type t + :param QualifiedName name: + :param Type t: :rtype: None """ if not isinstance(name, types.QualifiedName): @@ -296,11 +296,11 @@ class TypeLibrary(object): through NamedTypeReferences are already appropriately prepared. To add types and objects from an existing BinaryView, it is recommended to use - :py:meth:`BinaryView.export_type_to_library`, which will automatically pull in + :py:meth:`export_type_to_library <binaryninja.binaryview.BinaryView.export_type_to_library>`, which will automatically pull in all referenced types and record additional dependencies as needed. - :param QualifiedName name - :param Type t + :param QualifiedName name: + :param Type t: :rtype: None """ if not isinstance(name, types.QualifiedName): @@ -313,9 +313,9 @@ class TypeLibrary(object): """ `get_named_object` direct extracts a reference to a contained object -- when attempting to extract types from a library into a BinaryView, consider using - :py:meth:`BinaryView.import_library_object` instead. + :py:meth:`import_library_object <binaryninja.binaryview.BinaryView.import_library_object>` instead. - :param QualifiedName name + :param QualifiedName name: :rtype: Type """ if not isinstance(name, types.QualifiedName): @@ -329,9 +329,9 @@ class TypeLibrary(object): """ `get_named_type` direct extracts a reference to a contained type -- when attempting to extract types from a library into a BinaryView, consider using - :py:meth:`BinaryView.import_library_type` instead. + :py:meth:`import_library_type <binaryninja.binaryview.BinaryView.import_library_type>` instead. - :param QualifiedName name + :param QualifiedName name: :rtype: Type """ if not isinstance(name, types.QualifiedName): |
