From fdbd6bb11a0c47bf9ba1428e6bd432cd2ce72045 Mon Sep 17 00:00:00 2001 From: Alexander Andreev Date: Mon, 30 Sep 2019 11:58:53 +0300 Subject: Added test for check doc strings in crates. #1856 --- crates/ra_hir/src/code_model.rs | 2 ++ crates/ra_hir/src/code_model/docs.rs | 2 ++ crates/ra_hir/src/code_model/src.rs | 2 ++ crates/ra_hir/src/db.rs | 2 ++ crates/ra_hir/src/diagnostics.rs | 2 ++ crates/ra_hir/src/either.rs | 2 ++ crates/ra_hir/src/expr.rs | 2 ++ crates/ra_hir/src/expr/lower.rs | 2 ++ crates/ra_hir/src/expr/scope.rs | 2 ++ crates/ra_hir/src/expr/validation.rs | 2 ++ crates/ra_hir/src/from_source.rs | 2 ++ crates/ra_hir/src/ids.rs | 2 ++ crates/ra_hir/src/impl_block.rs | 2 ++ crates/ra_hir/src/lang_item.rs | 2 ++ crates/ra_hir/src/lib.rs | 4 ++-- crates/ra_hir/src/marks.rs | 2 ++ crates/ra_hir/src/mock.rs | 2 ++ crates/ra_hir/src/name.rs | 2 ++ crates/ra_hir/src/nameres/collector.rs | 2 ++ crates/ra_hir/src/nameres/per_ns.rs | 2 ++ crates/ra_hir/src/nameres/raw.rs | 2 ++ crates/ra_hir/src/path.rs | 2 ++ crates/ra_hir/src/source_binder.rs | 14 +++++++------- crates/ra_hir/src/source_id.rs | 2 ++ crates/ra_hir/src/ty/display.rs | 2 ++ crates/ra_hir/src/ty/op.rs | 2 ++ crates/ra_hir/src/ty/primitive.rs | 2 ++ 27 files changed, 59 insertions(+), 9 deletions(-) (limited to 'crates/ra_hir') diff --git a/crates/ra_hir/src/code_model.rs b/crates/ra_hir/src/code_model.rs index fd7afcbb6..e3a7e8e3c 100644 --- a/crates/ra_hir/src/code_model.rs +++ b/crates/ra_hir/src/code_model.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + pub(crate) mod src; pub(crate) mod docs; diff --git a/crates/ra_hir/src/code_model/docs.rs b/crates/ra_hir/src/code_model/docs.rs index 99edc5814..9675e397f 100644 --- a/crates/ra_hir/src/code_model/docs.rs +++ b/crates/ra_hir/src/code_model/docs.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::sync::Arc; use ra_syntax::ast; diff --git a/crates/ra_hir/src/code_model/src.rs b/crates/ra_hir/src/code_model/src.rs index dc964e156..fdae26906 100644 --- a/crates/ra_hir/src/code_model/src.rs +++ b/crates/ra_hir/src/code_model/src.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use ra_syntax::{ ast::{self, AstNode}, SyntaxNode, diff --git a/crates/ra_hir/src/db.rs b/crates/ra_hir/src/db.rs index deed1c62f..73d7d6fb6 100644 --- a/crates/ra_hir/src/db.rs +++ b/crates/ra_hir/src/db.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::sync::Arc; use ra_db::{salsa, SourceDatabase}; diff --git a/crates/ra_hir/src/diagnostics.rs b/crates/ra_hir/src/diagnostics.rs index 60da33695..9acdaf8ed 100644 --- a/crates/ra_hir/src/diagnostics.rs +++ b/crates/ra_hir/src/diagnostics.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::{any::Any, fmt}; use ra_syntax::{ast, AstNode, AstPtr, SyntaxNode, SyntaxNodePtr, TextRange}; diff --git a/crates/ra_hir/src/either.rs b/crates/ra_hir/src/either.rs index 439e6ec87..83583ef8b 100644 --- a/crates/ra_hir/src/either.rs +++ b/crates/ra_hir/src/either.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] pub enum Either { A(A), diff --git a/crates/ra_hir/src/expr.rs b/crates/ra_hir/src/expr.rs index b1bec2a68..d238741ba 100644 --- a/crates/ra_hir/src/expr.rs +++ b/crates/ra_hir/src/expr.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + pub(crate) mod lower; pub(crate) mod scope; pub(crate) mod validation; diff --git a/crates/ra_hir/src/expr/lower.rs b/crates/ra_hir/src/expr/lower.rs index 6d6f60506..50ea429ea 100644 --- a/crates/ra_hir/src/expr/lower.rs +++ b/crates/ra_hir/src/expr/lower.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use ra_arena::Arena; use ra_syntax::{ ast::{ diff --git a/crates/ra_hir/src/expr/scope.rs b/crates/ra_hir/src/expr/scope.rs index de0983a7e..5496822e7 100644 --- a/crates/ra_hir/src/expr/scope.rs +++ b/crates/ra_hir/src/expr/scope.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::sync::Arc; use ra_arena::{impl_arena_id, Arena, RawId}; diff --git a/crates/ra_hir/src/expr/validation.rs b/crates/ra_hir/src/expr/validation.rs index f06e5ec07..1aa853c3e 100644 --- a/crates/ra_hir/src/expr/validation.rs +++ b/crates/ra_hir/src/expr/validation.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::sync::Arc; use ra_syntax::ast; diff --git a/crates/ra_hir/src/from_source.rs b/crates/ra_hir/src/from_source.rs index 7b6d9b240..a012f33f7 100644 --- a/crates/ra_hir/src/from_source.rs +++ b/crates/ra_hir/src/from_source.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use ra_db::{FileId, FilePosition}; use ra_syntax::{ algo::find_node_at_offset, diff --git a/crates/ra_hir/src/ids.rs b/crates/ra_hir/src/ids.rs index bcbcd3dd7..a3b65cc79 100644 --- a/crates/ra_hir/src/ids.rs +++ b/crates/ra_hir/src/ids.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::{ hash::{Hash, Hasher}, sync::Arc, diff --git a/crates/ra_hir/src/impl_block.rs b/crates/ra_hir/src/impl_block.rs index c66a1c6a6..8cf74ddc7 100644 --- a/crates/ra_hir/src/impl_block.rs +++ b/crates/ra_hir/src/impl_block.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use rustc_hash::FxHashMap; use std::sync::Arc; diff --git a/crates/ra_hir/src/lang_item.rs b/crates/ra_hir/src/lang_item.rs index bcce314d8..8764240b3 100644 --- a/crates/ra_hir/src/lang_item.rs +++ b/crates/ra_hir/src/lang_item.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use rustc_hash::FxHashMap; use std::sync::Arc; diff --git a/crates/ra_hir/src/lib.rs b/crates/ra_hir/src/lib.rs index a9de9fb6b..00031deba 100644 --- a/crates/ra_hir/src/lib.rs +++ b/crates/ra_hir/src/lib.rs @@ -1,5 +1,3 @@ -#![recursion_limit = "512"] - //! HIR (previously known as descriptors) provides a high-level object oriented //! access to Rust code. //! @@ -7,6 +5,8 @@ //! to a particular crate instance. That is, it has cfg flags and features //! applied. So, the relation between syntax and HIR is many-to-one. +#![recursion_limit = "512"] + macro_rules! impl_froms { ($e:ident: $($v:ident $(($($sv:ident),*))?),*) => { $( diff --git a/crates/ra_hir/src/marks.rs b/crates/ra_hir/src/marks.rs index 0fed46802..79af24b20 100644 --- a/crates/ra_hir/src/marks.rs +++ b/crates/ra_hir/src/marks.rs @@ -1,3 +1,5 @@ +//! See test_utils/src/marks.rs + test_utils::marks!( bogus_paths name_res_works_for_broken_modules diff --git a/crates/ra_hir/src/mock.rs b/crates/ra_hir/src/mock.rs index cb405091e..50feb98fb 100644 --- a/crates/ra_hir/src/mock.rs +++ b/crates/ra_hir/src/mock.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::{panic, sync::Arc}; use parking_lot::Mutex; diff --git a/crates/ra_hir/src/name.rs b/crates/ra_hir/src/name.rs index d50867f5d..1e0b8c350 100644 --- a/crates/ra_hir/src/name.rs +++ b/crates/ra_hir/src/name.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::fmt; use ra_syntax::{ast, SmolStr}; diff --git a/crates/ra_hir/src/nameres/collector.rs b/crates/ra_hir/src/nameres/collector.rs index 65929c522..a568fdabd 100644 --- a/crates/ra_hir/src/nameres/collector.rs +++ b/crates/ra_hir/src/nameres/collector.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use ra_db::FileId; use ra_syntax::{ast, SmolStr}; use rustc_hash::FxHashMap; diff --git a/crates/ra_hir/src/nameres/per_ns.rs b/crates/ra_hir/src/nameres/per_ns.rs index 964da2794..0da6789de 100644 --- a/crates/ra_hir/src/nameres/per_ns.rs +++ b/crates/ra_hir/src/nameres/per_ns.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use crate::{MacroDef, ModuleDef}; #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] diff --git a/crates/ra_hir/src/nameres/raw.rs b/crates/ra_hir/src/nameres/raw.rs index c494b95b0..32a049f4e 100644 --- a/crates/ra_hir/src/nameres/raw.rs +++ b/crates/ra_hir/src/nameres/raw.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::{ops::Index, sync::Arc}; use ra_arena::{impl_arena_id, map::ArenaMap, Arena, RawId}; diff --git a/crates/ra_hir/src/path.rs b/crates/ra_hir/src/path.rs index 158c853d4..394617e1a 100644 --- a/crates/ra_hir/src/path.rs +++ b/crates/ra_hir/src/path.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::{iter, sync::Arc}; use ra_syntax::{ diff --git a/crates/ra_hir/src/source_binder.rs b/crates/ra_hir/src/source_binder.rs index 6e89bfc76..088335e66 100644 --- a/crates/ra_hir/src/source_binder.rs +++ b/crates/ra_hir/src/source_binder.rs @@ -1,10 +1,10 @@ -/// Lookup hir elements using positions in the source code. This is a lossy -/// transformation: in general, a single source might correspond to several -/// modules, functions, etc, due to macros, cfgs and `#[path=]` attributes on -/// modules. -/// -/// So, this modules should not be used during hir construction, it exists -/// purely for "IDE needs". +//! Lookup hir elements using positions in the source code. This is a lossy +//! transformation: in general, a single source might correspond to several +//! modules, functions, etc, due to macros, cfgs and `#[path=]` attributes on +//! modules. +//! +//! So, this modules should not be used during hir construction, it exists +//! purely for "IDE needs". use std::sync::Arc; use ra_db::FileId; diff --git a/crates/ra_hir/src/source_id.rs b/crates/ra_hir/src/source_id.rs index 04574876d..a4dd99598 100644 --- a/crates/ra_hir/src/source_id.rs +++ b/crates/ra_hir/src/source_id.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::{ hash::{Hash, Hasher}, marker::PhantomData, diff --git a/crates/ra_hir/src/ty/display.rs b/crates/ra_hir/src/ty/display.rs index 63ec9d7e1..7910429d7 100644 --- a/crates/ra_hir/src/ty/display.rs +++ b/crates/ra_hir/src/ty/display.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::fmt; use crate::db::HirDatabase; diff --git a/crates/ra_hir/src/ty/op.rs b/crates/ra_hir/src/ty/op.rs index 1b30a5b9b..bcfa3a6a2 100644 --- a/crates/ra_hir/src/ty/op.rs +++ b/crates/ra_hir/src/ty/op.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use super::{InferTy, Ty, TypeCtor}; use crate::{ expr::{BinaryOp, CmpOp}, diff --git a/crates/ra_hir/src/ty/primitive.rs b/crates/ra_hir/src/ty/primitive.rs index 2c60fefd6..8966f9d1d 100644 --- a/crates/ra_hir/src/ty/primitive.rs +++ b/crates/ra_hir/src/ty/primitive.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::fmt; #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)] -- cgit v1.2.3