From ad39c0a8a19af23faa8c4f36daf33a0c02c3e0b9 Mon Sep 17 00:00:00 2001 From: Nicholas Bishop Date: Sat, 27 Dec 2014 20:13:32 -0500 Subject: [PATCH] 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. --- src/libstd/bitflags.rs | 4 ++++ 1 file changed, 4 insertions(+) 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`