diff --git a/rust/src/function.rs b/rust/src/function.rs index e60f47d2d..91ba37090 100644 --- a/rust/src/function.rs +++ b/rust/src/function.rs @@ -1230,8 +1230,8 @@ impl Function { /// Returns a list of function Tags for the function. /// - /// `auto` - If None, gets all tags, if True, gets auto tags, if False, gets user tags - /// `tag_type` - If None, gets all tags, otherwise only gets tags of the given type + /// `auto` - If `None`, gets all tags, if `true`, gets auto tags, if `false`, gets user tags + /// `tag_type` - If `None`, gets all tags, otherwise only gets tags of the given type pub fn function_tags(&self, auto: Option, tag_type: Option<&str>) -> Array { let mut count = 0; @@ -1272,7 +1272,7 @@ impl Function { /// Gets a list of Tags at the address. /// /// * `addr` - Address to get tags from. - /// * `auto` - If None, gets all tags, if True, gets auto tags, if False, gets user tags + /// * `auto` - If `None`, gets all tags, if `true`, gets auto tags, if `false`, gets user tags pub fn tags_at( &self, addr: u64, @@ -1294,7 +1294,7 @@ impl Function { /// Gets a list of Tags in the address range. /// /// * `addr` - Address to get tags from. - /// * `auto` - If None, gets all tags, if True, gets auto tags, if False, gets user tags + /// * `auto` - If `None`, gets all tags, if `true`, gets auto tags, if `false`, gets user tags pub fn tags_in_range( &self, range: Range, @@ -1407,7 +1407,7 @@ impl Function { /// Sets the highlights the instruction at the specified address with the supplied color /// - /// .. warning:: Use only in analysis plugins. Do not use in regular plugins, as colors won't be saved to the database. + ///
Use only in analysis plugins. Do not use in regular plugins, as colors won't be saved to the database.
/// /// * `addr` - virtual address of the instruction to be highlighted /// * `color` - Color value to use for highlighting @@ -1887,12 +1887,16 @@ impl Function { /// This function is not meant to split variables that have been previously merged. Use /// `unmerge_vars` to split previously merged variables. /// - /// .. warning:: Binary Ninja automatically splits all variables that the analysis determines \ - /// to be safely splittable. Splitting a variable manually with `split_var` can cause \ - /// IL and decompilation to be incorrect. There are some patterns where variables can be safely \ - /// split semantically but analysis cannot determine that it is safe. This function is provided \ + ///
+ /// + /// Binary Ninja automatically splits all variables that the analysis determines + /// to be safely splittable. Splitting a variable manually with `split_var` can cause + /// IL and decompilation to be incorrect. There are some patterns where variables can be safely + /// split semantically but analysis cannot determine that it is safe. This function is provided /// to allow variable splitting to be performed in these cases by plugins or by the user. /// + ///
+ /// /// * `var` - variable to split pub fn split_variable(&self, var: &Variable) { unsafe { BNSplitVariable(self.handle, &var.raw()) } @@ -1911,8 +1915,12 @@ impl Function { /// /// * `update_type` - Desired update type /// - /// .. warning:: If analysis_skipped is True, using this API will not trigger - /// re-analysis. Instead, use [Function::set_analysis_skipped] with `False`. + ///
+ /// + /// If analysis_skipped is `true`, using this API will not trigger + /// re-analysis. Instead, use [Function::set_analysis_skipped] with `false`. + /// + ///
pub fn reanalyze(&self, update_type: FunctionUpdateType) { unsafe { BNReanalyzeFunction(self.handle, update_type) } }