Added test for check doc strings in crates.

#1856

crates/ra_ide_api/src/assists.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_db::{FilePosition, FileRange};
 
 use crate::{db::RootDatabase, SourceChange, SourceFileEdit};

crates/ra_ide_api/src/call_info.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_db::SourceDatabase;
 use ra_syntax::{
     algo::find_node_at_offset,

crates/ra_ide_api/src/change.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use std::{fmt, sync::Arc, time};
 
 use ra_db::{

crates/ra_ide_api/src/completion.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 mod completion_item;
 mod completion_context;
 mod presentation;

crates/ra_ide_api/src/completion/complete_dot.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use hir::{Adt, Ty, TypeCtor};
 
 use crate::completion::completion_item::CompletionKind;

crates/ra_ide_api/src/completion/complete_fn_param.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_syntax::{
     algo::visit::{visitor_ctx, VisitorCtx},
     ast, AstNode,

crates/ra_ide_api/src/completion/complete_keyword.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_syntax::{
     algo::visit::{visitor, Visitor},
     ast::{self, LoopBodyOwner},

crates/ra_ide_api/src/completion/complete_macro_in_item_position.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use crate::completion::{CompletionContext, Completions};
 
 pub(super) fn complete_macro_in_item_position(acc: &mut Completions, ctx: &CompletionContext) {

crates/ra_ide_api/src/completion/complete_path.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use hir::{Adt, Either, PathResolution};
 use ra_syntax::AstNode;
 use test_utils::tested_by;

crates/ra_ide_api/src/completion/complete_pattern.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use crate::completion::{CompletionContext, Completions};
 
 /// Completes constats and paths in patterns.

crates/ra_ide_api/src/completion/complete_postfix.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use crate::{
     completion::{
         completion_context::CompletionContext,

crates/ra_ide_api/src/completion/complete_record_literal.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use hir::Substs;
 
 use crate::completion::{CompletionContext, Completions};

crates/ra_ide_api/src/completion/complete_record_pattern.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use hir::Substs;
 
 use crate::completion::{CompletionContext, Completions};

crates/ra_ide_api/src/completion/complete_scope.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_assists::auto_import_text_edit;
 use ra_syntax::{ast, AstNode, SmolStr};
 use ra_text_edit::TextEditBuilder;

crates/ra_ide_api/src/completion/complete_snippet.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use crate::completion::{
     completion_item::Builder, CompletionContext, CompletionItem, CompletionItemKind,
     CompletionKind, Completions,

crates/ra_ide_api/src/completion/completion_context.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_syntax::{
     algo::{find_covering_element, find_node_at_offset},
     ast, AstNode, Parse, SourceFile,

crates/ra_ide_api/src/completion/completion_item.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use std::fmt;
 
 use hir::Documentation;

crates/ra_ide_api/src/completion/presentation.rs

@@ -1,4 +1,5 @@
 //! This modules takes care of rendering various definitions as completion items.
+
 use hir::{Docs, HasSource, HirDisplay, ScopeDef, Ty, TypeWalk};
 use join_to_string::join;
 use ra_syntax::ast::NameOwner;

crates/ra_ide_api/src/db.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use std::sync::Arc;
 
 use ra_db::{

crates/ra_ide_api/src/diagnostics.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use std::cell::RefCell;
 
 use hir::diagnostics::{AstDiagnostic, Diagnostic as _, DiagnosticSink};

crates/ra_ide_api/src/display/function_signature.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use std::fmt::{self, Display};
 
 use hir::{Docs, Documentation, HasSource};

crates/ra_ide_api/src/display/navigation_target.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use hir::{AssocItem, FieldSource, HasSource, ModuleSource};
 use ra_db::{FileId, SourceDatabase};
 use ra_syntax::{

crates/ra_ide_api/src/display/short_label.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use format_buf::format;
 use ra_syntax::ast::{self, AstNode, NameOwner, TypeAscriptionOwner, VisibilityOwner};
 

crates/ra_ide_api/src/display/structure.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use crate::TextRange;
 
 use ra_syntax::{

crates/ra_ide_api/src/extend_selection.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_db::SourceDatabase;
 use ra_syntax::{
     algo::find_covering_element,

crates/ra_ide_api/src/feature_flags.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use rustc_hash::FxHashMap;
 
 /// Feature flags hold fine-grained toggles for all *user-visible* features of

crates/ra_ide_api/src/folding_ranges.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use rustc_hash::FxHashSet;
 
 use ra_syntax::{

crates/ra_ide_api/src/goto_definition.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_db::{FileId, SourceDatabase};
 use ra_syntax::{
     algo::{

crates/ra_ide_api/src/goto_type_definition.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_db::SourceDatabase;
 use ra_syntax::{ast, AstNode};
 

crates/ra_ide_api/src/hover.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use hir::{Adt, HasSource, HirDisplay};
 use ra_db::SourceDatabase;
 use ra_syntax::{

crates/ra_ide_api/src/impls.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use hir::{db::HirDatabase, ApplicationTy, FromSource, Ty, TypeCtor};
 use ra_db::SourceDatabase;
 use ra_syntax::{algo::find_node_at_offset, ast, AstNode};

crates/ra_ide_api/src/inlay_hints.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use crate::{db::RootDatabase, FileId};
 use hir::{HirDisplay, SourceAnalyzer, Ty};
 use ra_syntax::{

crates/ra_ide_api/src/join_lines.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use itertools::Itertools;
 use ra_fmt::{compute_ws, extract_trivial_expression};
 use ra_syntax::{

crates/ra_ide_api/src/line_index.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use crate::TextUnit;
 use rustc_hash::FxHashMap;
 use superslice::Ext;

crates/ra_ide_api/src/line_index_utils.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use crate::{line_index::Utf16Char, LineCol, LineIndex};
 use ra_syntax::{TextRange, TextUnit};
 use ra_text_edit::{AtomTextEdit, TextEdit};

crates/ra_ide_api/src/marks.rs

@@ -1,3 +1,5 @@
+//! See test_utils/src/marks.rs
+
 test_utils::marks!(
     inserts_parens_for_function_calls
     goto_definition_works_for_macros

crates/ra_ide_api/src/matching_brace.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_syntax::{ast::AstNode, SourceFile, SyntaxKind, TextUnit, T};
 
 pub fn matching_brace(file: &SourceFile, offset: TextUnit) -> Option<TextUnit> {

crates/ra_ide_api/src/mock_analysis.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use std::sync::Arc;
 
 use relative_path::RelativePathBuf;

crates/ra_ide_api/src/name_ref_kind.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use hir::Either;
 use ra_syntax::{ast, AstNode, AstPtr};
 use test_utils::tested_by;

crates/ra_ide_api/src/parent_module.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_db::{CrateId, FileId, FilePosition};
 
 use crate::{db::RootDatabase, NavigationTarget};

crates/ra_ide_api/src/references.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use hir::{Either, ModuleSource};
 use ra_db::SourceDatabase;
 use ra_syntax::{algo::find_node_at_offset, ast, AstNode, SourceFile, SyntaxNode};

crates/ra_ide_api/src/runnables.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use itertools::Itertools;
 use ra_db::SourceDatabase;
 use ra_syntax::{

crates/ra_ide_api/src/status.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use std::{fmt, iter::FromIterator, sync::Arc};
 
 use hir::MacroFile;

crates/ra_ide_api/src/syntax_highlighting.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use rustc_hash::{FxHashMap, FxHashSet};
 
 use hir::{Mutability, Ty};

crates/ra_ide_api/src/syntax_tree.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use crate::db::RootDatabase;
 use ra_db::SourceDatabase;
 use ra_syntax::{

crates/ra_ide_api/src/test_utils.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_syntax::{SourceFile, TextUnit};
 use ra_text_edit::TextEdit;
 

crates/ra_ide_api/src/typing.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use ra_db::{FilePosition, SourceDatabase};
 use ra_fmt::leading_indent;
 use ra_syntax::{

crates/ra_ide_api/src/wasm_shims.rs

@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 #[cfg(not(feature = "wasm"))]
 pub use std::time::Instant;