diff options
| author | Nicholas Bishop <nicholasbishop@gmail.com> | 2014-12-27 20:13:32 -0500 |
|---|---|---|
| committer | Nicholas Bishop <nicholasbishop@gmail.com> | 2014-12-27 20:13:32 -0500 |
| commit | ad39c0a8a19af23faa8c4f36daf33a0c02c3e0b9 (patch) | |
| tree | 970e87619dfff0eea7745457f30504147d97e52c | |
| parent | 070ab63807dc80fa6a6c5ee80531284761ab42de (diff) | |
| download | rust-ad39c0a8a19af23faa8c4f36daf33a0c02c3e0b9.tar.gz rust-ad39c0a8a19af23faa8c4f36daf33a0c02c3e0b9.zip | |
Update docstring for bitflags macro to cover all generated methods
The methods `from_bits` and `from_bits_truncate` were missing from the list of generated methods. Didn't see a useful way to abbreviate, so added with the same docstrings used in the macro definition.
| -rw-r--r-- | src/libstd/bitflags.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libstd/bitflags.rs b/src/libstd/bitflags.rs index 5dd76047779..a46b8a9ad90 100644 --- a/src/libstd/bitflags.rs +++ b/src/libstd/bitflags.rs @@ -104,6 +104,10 @@ /// - `empty`: an empty set of flags /// - `all`: the set of all flags /// - `bits`: the raw value of the flags currently stored +/// - `from_bits`: convert from underlying bit representation, unless that +/// representation contains bits that do not correspond to a flag +/// - `from_bits_truncate`: convert from underlying bit representation, dropping +/// any bits that do not correspond to flags /// - `is_empty`: `true` if no flags are currently stored /// - `is_all`: `true` if all flags are currently set /// - `intersects`: `true` if there are flags common to both `self` and `other` |