Skip to content

Minor documentation changes #435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 24, 2017
Merged

Minor documentation changes #435

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,41 +182,41 @@ impl Builder {
self
}

/// Hide the given type from the generated bindings.
/// Hide the given type from the generated bindings. Regular expressions are supported.
pub fn hide_type<T: AsRef<str>>(mut self, arg: T) -> Builder {
self.options.hidden_types.insert(arg);
self
}

/// Treat the given type as opaque in the generated bindings.
/// Treat the given type as opaque in the generated bindings. Regular expressions are supported.
pub fn opaque_type<T: AsRef<str>>(mut self, arg: T) -> Builder {
self.options.opaque_types.insert(arg);
self
}

/// Whitelist the given type so that it (and all types that it transitively
/// refers to) appears in the generated bindings.
/// refers to) appears in the generated bindings. Regular expressions are supported.
pub fn whitelisted_type<T: AsRef<str>>(mut self, arg: T) -> Builder {
self.options.whitelisted_types.insert(arg);
self
}

/// Whitelist the given function so that it (and all types that it
/// transitively refers to) appears in the generated bindings.
/// transitively refers to) appears in the generated bindings. Regular expressions are supported.
pub fn whitelisted_function<T: AsRef<str>>(mut self, arg: T) -> Builder {
self.options.whitelisted_functions.insert(arg);
self
}

/// Whitelist the given variable so that it (and all types that it
/// transitively refers to) appears in the generated bindings.
/// transitively refers to) appears in the generated bindings. Regular expressions are supported.
pub fn whitelisted_var<T: AsRef<str>>(mut self, arg: T) -> Builder {
self.options.whitelisted_vars.insert(arg);
self
}

/// Mark the given enum (or set of enums, if using a pattern) as being
/// bitfield-like.
/// bitfield-like. Regular expressions are supported.
///
/// This makes bindgen generate a type that isn't a rust `enum`.
pub fn bitfield_enum<T: AsRef<str>>(mut self, arg: T) -> Builder {
Expand Down Expand Up @@ -350,7 +350,7 @@ impl Builder {
self
}

/// Avoid generating any unstable Rust in the generated bindings.
/// Avoid generating any unstable Rust, such as Rust unions, in the generated bindings.
pub fn no_unstable_rust(mut self) -> Builder {
self.options.unstable_rust = false;
self
Expand Down