From dc1577d58d0339b3d77739e33ae5e527ae6f6589 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Sat, 22 May 2021 17:20:22 +0300 Subject: Add even more docs --- crates/parser/src/grammar.rs | 1 + crates/parser/src/grammar/attributes.rs | 2 -- crates/parser/src/grammar/expressions.rs | 2 -- crates/parser/src/grammar/expressions/atom.rs | 2 -- crates/parser/src/grammar/items.rs | 2 -- crates/parser/src/grammar/items/adt.rs | 2 -- crates/parser/src/grammar/items/consts.rs | 2 -- crates/parser/src/grammar/items/traits.rs | 2 -- crates/parser/src/grammar/items/use_item.rs | 2 -- crates/parser/src/grammar/params.rs | 2 -- crates/parser/src/grammar/paths.rs | 2 -- crates/parser/src/grammar/patterns.rs | 2 -- crates/parser/src/grammar/type_args.rs | 2 -- crates/parser/src/grammar/type_params.rs | 2 -- crates/parser/src/grammar/types.rs | 2 -- crates/parser/src/parser.rs | 2 +- crates/parser/src/syntax_kind.rs | 3 ++- 17 files changed, 4 insertions(+), 30 deletions(-) (limited to 'crates/parser/src') diff --git a/crates/parser/src/grammar.rs b/crates/parser/src/grammar.rs index 9bdf0b5fa..790908aea 100644 --- a/crates/parser/src/grammar.rs +++ b/crates/parser/src/grammar.rs @@ -27,6 +27,7 @@ //! node or an error, rules like `opt_where_clause` may produce nothing. //! Non-opt rules typically start with `assert!(p.at(FIRST_TOKEN))`, the //! caller is responsible for branching on the first token. + mod attributes; mod expressions; mod items; diff --git a/crates/parser/src/grammar/attributes.rs b/crates/parser/src/grammar/attributes.rs index 124a10eb2..b8242cd2f 100644 --- a/crates/parser/src/grammar/attributes.rs +++ b/crates/parser/src/grammar/attributes.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; pub(super) fn inner_attrs(p: &mut Parser) { diff --git a/crates/parser/src/grammar/expressions.rs b/crates/parser/src/grammar/expressions.rs index 0d9dc9348..9d22e1950 100644 --- a/crates/parser/src/grammar/expressions.rs +++ b/crates/parser/src/grammar/expressions.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - mod atom; pub(crate) use self::atom::{block_expr, match_arm_list}; diff --git a/crates/parser/src/grammar/expressions/atom.rs b/crates/parser/src/grammar/expressions/atom.rs index 093a9890d..269f223e6 100644 --- a/crates/parser/src/grammar/expressions/atom.rs +++ b/crates/parser/src/grammar/expressions/atom.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; // test expr_literals diff --git a/crates/parser/src/grammar/items.rs b/crates/parser/src/grammar/items.rs index adec74ef3..1057ca8c2 100644 --- a/crates/parser/src/grammar/items.rs +++ b/crates/parser/src/grammar/items.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - mod consts; mod adt; mod traits; diff --git a/crates/parser/src/grammar/items/adt.rs b/crates/parser/src/grammar/items/adt.rs index 67c0c5697..386d3806c 100644 --- a/crates/parser/src/grammar/items/adt.rs +++ b/crates/parser/src/grammar/items/adt.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; pub(super) fn strukt(p: &mut Parser, m: Marker) { diff --git a/crates/parser/src/grammar/items/consts.rs b/crates/parser/src/grammar/items/consts.rs index 12130df40..ed3bee4a4 100644 --- a/crates/parser/src/grammar/items/consts.rs +++ b/crates/parser/src/grammar/items/consts.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; pub(super) fn static_(p: &mut Parser, m: Marker) { diff --git a/crates/parser/src/grammar/items/traits.rs b/crates/parser/src/grammar/items/traits.rs index d3327271c..74f11b45a 100644 --- a/crates/parser/src/grammar/items/traits.rs +++ b/crates/parser/src/grammar/items/traits.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; // test trait_item diff --git a/crates/parser/src/grammar/items/use_item.rs b/crates/parser/src/grammar/items/use_item.rs index 5cb8b08e7..2339d0c69 100644 --- a/crates/parser/src/grammar/items/use_item.rs +++ b/crates/parser/src/grammar/items/use_item.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; pub(super) fn use_(p: &mut Parser, m: Marker) { diff --git a/crates/parser/src/grammar/params.rs b/crates/parser/src/grammar/params.rs index 9e2f02d43..01ee26a53 100644 --- a/crates/parser/src/grammar/params.rs +++ b/crates/parser/src/grammar/params.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; // test param_list diff --git a/crates/parser/src/grammar/paths.rs b/crates/parser/src/grammar/paths.rs index b10f48fe1..e633646c3 100644 --- a/crates/parser/src/grammar/paths.rs +++ b/crates/parser/src/grammar/paths.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; pub(super) const PATH_FIRST: TokenSet = diff --git a/crates/parser/src/grammar/patterns.rs b/crates/parser/src/grammar/patterns.rs index f1d1f9eaa..bd092e0af 100644 --- a/crates/parser/src/grammar/patterns.rs +++ b/crates/parser/src/grammar/patterns.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; pub(super) const PATTERN_FIRST: TokenSet = diff --git a/crates/parser/src/grammar/type_args.rs b/crates/parser/src/grammar/type_args.rs index be36cad17..ed2322e52 100644 --- a/crates/parser/src/grammar/type_args.rs +++ b/crates/parser/src/grammar/type_args.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; pub(super) fn opt_generic_arg_list(p: &mut Parser, colon_colon_required: bool) { diff --git a/crates/parser/src/grammar/type_params.rs b/crates/parser/src/grammar/type_params.rs index b1f979281..49d6fa6d0 100644 --- a/crates/parser/src/grammar/type_params.rs +++ b/crates/parser/src/grammar/type_params.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; pub(super) fn opt_generic_param_list(p: &mut Parser) { diff --git a/crates/parser/src/grammar/types.rs b/crates/parser/src/grammar/types.rs index 6ae3e734f..72476c190 100644 --- a/crates/parser/src/grammar/types.rs +++ b/crates/parser/src/grammar/types.rs @@ -1,5 +1,3 @@ -//! FIXME: write short doc here - use super::*; pub(super) const TYPE_FIRST: TokenSet = paths::PATH_FIRST.union(TokenSet::new(&[ diff --git a/crates/parser/src/parser.rs b/crates/parser/src/parser.rs index 81e26e009..3f87d98a8 100644 --- a/crates/parser/src/parser.rs +++ b/crates/parser/src/parser.rs @@ -1,4 +1,4 @@ -//! FIXME: write short doc here +//! See [`Parser`]. use std::cell::Cell; diff --git a/crates/parser/src/syntax_kind.rs b/crates/parser/src/syntax_kind.rs index 9ea0e4f9b..4d4377422 100644 --- a/crates/parser/src/syntax_kind.rs +++ b/crates/parser/src/syntax_kind.rs @@ -1,4 +1,5 @@ -//! FIXME: write short doc here +//! Defines [`SyntaxKind`] -- a fieldless enum of all possible syntactic +//! constructs of the Rust language. #[macro_use] mod generated; -- cgit v1.2.3