summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorjethrogb <github@jbeekman.nl>2017-01-24 00:51:19 -0800
committerGitHub <noreply@github.com>2017-01-24 00:51:19 -0800
commit90d440443520287e74a61644b806697814a72007 (patch)
treee6dd1949e4ebd8052fd91f3738cc5cb46409b45b /src
parent615130d8f74ff005ffc44e96b9ddd2bcaa4c4e76 (diff)
Minor documentation changes
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 60b750de..88da1a48 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -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 {
@@ -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