doc+disclaimer

This commit is contained in:
Gilad Naaman
2017-10-17 09:04:17 +03:00
parent e96f43aa32
commit 16fca9241f
+10 -1
View File
@@ -37,9 +37,18 @@
/// span_of!(Struct, member_a .. member_b)
/// // Inclusive
/// span_of!(Struct, member_a ..= member_b)
///
/// // Open-ended ranges
/// span_of!(Struct, .. end)
/// span_of!(Struct, start ..)
/// ```
///
/// *Note*: This macro may not make much sense when used on structs that are not `#[repr(C, packed)]`
/// *Note*:
/// This macro uses recursion in order to resolve the range expressions, so there is a limit to the complexity of the expression.
/// In order to raise the limit, the compiler's recursion limit should be lifted.
///
/// *Note*:
/// This macro may not make much sense when used on structs that are not `#[repr(C, packed)]`
///
/// ## Examples
/// ```