Skip to content

Commit 90d4404

Browse files
authored
Minor documentation changes
1 parent 615130d commit 90d4404

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/lib.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -182,41 +182,41 @@ impl Builder {
182182
self
183183
}
184184

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

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

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

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

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

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

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

0 commit comments

Comments
 (0)