Fix docs for frida (see #2025) (#2027)

This commit is contained in:
Dominik Maier 2024-04-09 12:48:24 +02:00 committed by GitHub
parent 7479726c3e
commit ef25aef471
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -131,7 +131,7 @@ pub enum SkipRange {
}, },
} }
/// Builder for [`FridaInstrumentationHelper`](FridaInstrumentationHelper) /// Builder for [`FridaInstrumentationHelper`]
pub struct FridaInstrumentationHelperBuilder { pub struct FridaInstrumentationHelperBuilder {
stalker_enabled: bool, stalker_enabled: bool,
disable_excludes: bool, disable_excludes: bool,
@ -142,14 +142,14 @@ pub struct FridaInstrumentationHelperBuilder {
} }
impl FridaInstrumentationHelperBuilder { impl FridaInstrumentationHelperBuilder {
/// Create a new `FridaInstrumentationHelperBuilder` /// Create a new [`FridaInstrumentationHelperBuilder`]
pub fn new() -> Self { pub fn new() -> Self {
Self::default() Self::default()
} }
/// Enable or disable the Stalker /// Enable or disable the [`Stalker`](https://frida.re/docs/stalker/)
/// ///
/// Required for coverage collection, ASAN, and `CmpLog`. /// Required for all instrumentation, such as coverage collection, `ASan`, and `CmpLog`.
/// Enabled by default. /// Enabled by default.
#[must_use] #[must_use]
pub fn enable_stalker(self, enabled: bool) -> Self { pub fn enable_stalker(self, enabled: bool) -> Self {
@ -239,7 +239,7 @@ impl FridaInstrumentationHelperBuilder {
self self
} }
/// Build a `FridaInstrumentationHelper` /// Build a [`FridaInstrumentationHelper`]
pub fn build<RT: FridaRuntimeTuple>( pub fn build<RT: FridaRuntimeTuple>(
self, self,
gum: &Gum, gum: &Gum,
@ -396,9 +396,9 @@ where
} }
impl<'a> FridaInstrumentationHelper<'a, ()> { impl<'a> FridaInstrumentationHelper<'a, ()> {
/// Create a builder to initialize a `FridaInstrumentationHelper`. /// Create a builder to initialize a [`FridaInstrumentationHelper`].
/// ///
/// See the documentation of [`FridaInstrumentationHelperBuilder`](FridaInstrumentationHelperBuilder) /// See the documentation of [`FridaInstrumentationHelperBuilder`]
/// for more details. /// for more details.
pub fn builder() -> FridaInstrumentationHelperBuilder { pub fn builder() -> FridaInstrumentationHelperBuilder {
FridaInstrumentationHelperBuilder::default() FridaInstrumentationHelperBuilder::default()