Rustdoc-ify LiteralKind note

This commit is contained in:
est31 2023-03-03 04:16:52 +01:00
parent ef658907a5
commit 5a02105fff

View File

@ -166,15 +166,17 @@ pub enum DocStyle {
Inner, Inner,
} }
// Note that the suffix is *not* considered when deciding the `LiteralKind` in /// Enum representing the literal types supported by the lexer.
// this type. This means that float literals like `1f32` are classified by this ///
// type as `Int`. (Compare against `rustc_ast::token::LitKind` and /// Note that the suffix is *not* considered when deciding the `LiteralKind` in
// `rustc_ast::ast::LitKind.) /// this type. This means that float literals like `1f32` are classified by this
/// type as `Int`. (Compare against `rustc_ast::token::LitKind` and
/// `rustc_ast::ast::LitKind`).
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)] #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub enum LiteralKind { pub enum LiteralKind {
/// "12_u8", "0o100", "0b120i99", "1f32". /// "12_u8", "0o100", "0b120i99", "1f32".
Int { base: Base, empty_int: bool }, Int { base: Base, empty_int: bool },
/// "12.34f32", "1e3", but not "1f32`. /// "12.34f32", "1e3", but not "1f32".
Float { base: Base, empty_exponent: bool }, Float { base: Base, empty_exponent: bool },
/// "'a'", "'\\'", "'''", "';" /// "'a'", "'\\'", "'''", "';"
Char { terminated: bool }, Char { terminated: bool },