diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2023-06-28 23:40:59 +0100 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2023-06-28 23:40:59 +0100 |
| commit | 09e327e88c979de7229e8cb139f9d55a65c881fd (patch) | |
| tree | 4880205be680711b7735090987fd4b11c99ffb75 /docs/dev/annotation.md | |
| parent | e2383ff7820c4bfd2d3a395c7994083d4c37e76e (diff) | |
small doc changes
Diffstat (limited to 'docs/dev/annotation.md')
| -rw-r--r-- | docs/dev/annotation.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/dev/annotation.md b/docs/dev/annotation.md index e7acc7b5..81a91424 100644 --- a/docs/dev/annotation.md +++ b/docs/dev/annotation.md @@ -1,16 +1,16 @@ # Applying Annotations -This document is organized into five sections describing how to work with types in Binary Ninja: +This document is organized into five sections describing how to work with various types of annotations in Binary Ninja using the API. Note that its [companion documentation](../guide/type.md) describes how to interact with many of the same elements via the UI. 1. [Symbols](#symbols) covers how to work with Symbols in a binary -1. [Types](#types) is how to create and interact with types through the API -1. [Tags](#tags) is about how to create tags and bookmarks +1. [Types](#types) documents creating and interacting with types through the API +1. [Tags](#tags) describes how to create tags and bookmarks 1. [Type Libraries](#type-libraries) explains how to work with Type Libraries, including multiple sources of information from which Binary Ninja can automatically source for type information from and how you can add to them 1. [Signature Libraries](#signature-library) explains how to work with the signature library which match statically compiled functions which are then matched with type libraries ## Symbols -From an API perspective there are several helper functions, for example to rename a function: +From an API perspective there are several helper functions available for working with Symbols. For example, to rename a function: ```py >>> current_function.name @@ -20,7 +20,7 @@ From an API perspective there are several helper functions, for example to renam 'newName' ``` -Other objects or variables may need a [symbol](https://api.binary.ninja/binaryninja.types.Symbol.html) created and applied: +Other objects or variables may need a [symbol](https://api.binary.ninja/binaryninja.types.Symbol.html) created and applied (this can also be done even if not using a helper function on objects such as functions): ```py >>> mysym = Symbol(SymbolType.FunctionSymbol, here, "myVariableName") |
