From 046a5679e36c79b152c484372f020d5945b697a0 Mon Sep 17 00:00:00 2001
From: Maybe Waffle <waffle.lapkin@gmail.com>
Date: Tue, 20 Dec 2022 13:30:53 +0000
Subject: [PATCH] Add docs to make tidy tests happy :')

---
 crates/ide/src/inlay_hints/adjustment.rs      | 5 +++++
 crates/ide/src/inlay_hints/bind_pat.rs        | 5 +++++
 crates/ide/src/inlay_hints/binding_mode.rs    | 4 ++++
 crates/ide/src/inlay_hints/chaining.rs        | 1 +
 crates/ide/src/inlay_hints/closing_brace.rs   | 5 +++++
 crates/ide/src/inlay_hints/closure_ret.rs     | 1 +
 crates/ide/src/inlay_hints/fn_lifetime_fn.rs  | 4 ++++
 crates/ide/src/inlay_hints/implicit_static.rs | 4 ++++
 crates/ide/src/inlay_hints/param_name.rs      | 5 +++++
 9 files changed, 34 insertions(+)

diff --git a/crates/ide/src/inlay_hints/adjustment.rs b/crates/ide/src/inlay_hints/adjustment.rs
index 2722e2c8623e..983aa1dfd56c 100644
--- a/crates/ide/src/inlay_hints/adjustment.rs
+++ b/crates/ide/src/inlay_hints/adjustment.rs
@@ -1,3 +1,8 @@
+//! Implementation of "adjustment" inlay hints:
+//! ```no_run
+//! let _: u32  = /* <never-to-any> */ loop {};
+//! let _: &u32 = /* &* */ &mut 0;
+//! ```
 use hir::{Adjust, AutoBorrow, Mutability, OverloadedDeref, PointerCast, Safety, Semantics};
 use ide_db::RootDatabase;
 
diff --git a/crates/ide/src/inlay_hints/bind_pat.rs b/crates/ide/src/inlay_hints/bind_pat.rs
index 6a19e83e5bbb..754df09df1d1 100644
--- a/crates/ide/src/inlay_hints/bind_pat.rs
+++ b/crates/ide/src/inlay_hints/bind_pat.rs
@@ -1,3 +1,8 @@
+//! Implementation of "type" inlay hints:
+//! ```no_run
+//! fn f(a: i32, b: i32) -> i32 { a + b }
+//! let _x /* i32 */= f(4, 4);
+//! ```
 use hir::{HirDisplay, Semantics, TypeInfo};
 use ide_db::{base_db::FileId, famous_defs::FamousDefs, RootDatabase};
 
diff --git a/crates/ide/src/inlay_hints/binding_mode.rs b/crates/ide/src/inlay_hints/binding_mode.rs
index 5c675efe80eb..846f0a4e0c16 100644
--- a/crates/ide/src/inlay_hints/binding_mode.rs
+++ b/crates/ide/src/inlay_hints/binding_mode.rs
@@ -1,3 +1,7 @@
+//! Implementation of "binding mode" inlay hints:
+//! ```no_run
+//! let /* & */ (/* ref */ x,) = &(0,);
+//! ```
 use hir::{Mutability, Semantics};
 use ide_db::RootDatabase;
 
diff --git a/crates/ide/src/inlay_hints/chaining.rs b/crates/ide/src/inlay_hints/chaining.rs
index 1dd51f5421ad..32421afd39ff 100644
--- a/crates/ide/src/inlay_hints/chaining.rs
+++ b/crates/ide/src/inlay_hints/chaining.rs
@@ -1,3 +1,4 @@
+//! Implementation of "chaining" inlay hints.
 use hir::{HirDisplay, Semantics};
 use ide_db::{famous_defs::FamousDefs, RootDatabase};
 use syntax::{
diff --git a/crates/ide/src/inlay_hints/closing_brace.rs b/crates/ide/src/inlay_hints/closing_brace.rs
index a40c931f4aaf..57605b392a81 100644
--- a/crates/ide/src/inlay_hints/closing_brace.rs
+++ b/crates/ide/src/inlay_hints/closing_brace.rs
@@ -1,3 +1,8 @@
+//! Implementation of "closing brace" inlay hints:
+//! ```no_run
+//! fn g() {
+//! } /* fn g */
+//! ```
 use hir::{HirDisplay, Semantics};
 use ide_db::{base_db::FileRange, RootDatabase};
 use syntax::{
diff --git a/crates/ide/src/inlay_hints/closure_ret.rs b/crates/ide/src/inlay_hints/closure_ret.rs
index 1843c4a80fac..de04f3ac7516 100644
--- a/crates/ide/src/inlay_hints/closure_ret.rs
+++ b/crates/ide/src/inlay_hints/closure_ret.rs
@@ -1,3 +1,4 @@
+//! Implementation of "closure return type" inlay hints.
 use hir::{HirDisplay, Semantics};
 use ide_db::{base_db::FileId, famous_defs::FamousDefs, RootDatabase};
 use syntax::ast::{self, AstNode};
diff --git a/crates/ide/src/inlay_hints/fn_lifetime_fn.rs b/crates/ide/src/inlay_hints/fn_lifetime_fn.rs
index 25a4866fc324..1f5bcea63a20 100644
--- a/crates/ide/src/inlay_hints/fn_lifetime_fn.rs
+++ b/crates/ide/src/inlay_hints/fn_lifetime_fn.rs
@@ -1,3 +1,7 @@
+//! Implementation of "lifetime elision" inlay hints:
+//! ```no_run
+//! fn example/* <'0> */(a: &/* '0 */()) {}
+//! ```
 use ide_db::{syntax_helpers::node_ext::walk_ty, FxHashMap};
 use itertools::Itertools;
 use syntax::SmolStr;
diff --git a/crates/ide/src/inlay_hints/implicit_static.rs b/crates/ide/src/inlay_hints/implicit_static.rs
index 299230db8d7a..588a0e3b6a4b 100644
--- a/crates/ide/src/inlay_hints/implicit_static.rs
+++ b/crates/ide/src/inlay_hints/implicit_static.rs
@@ -1,3 +1,7 @@
+//! Implementation of "implicit static" inlay hints:
+//! ```no_run
+//! static S: &/* 'static */str = "";
+//! ```
 use either::Either;
 use syntax::{
     ast::{self, AstNode},
diff --git a/crates/ide/src/inlay_hints/param_name.rs b/crates/ide/src/inlay_hints/param_name.rs
index c16ae5936b5e..ecee67632e35 100644
--- a/crates/ide/src/inlay_hints/param_name.rs
+++ b/crates/ide/src/inlay_hints/param_name.rs
@@ -1,3 +1,8 @@
+//! Implementation of "param name" inlay hints:
+//! ```no_run
+//! fn max(x: i32, y: i32) -> i32 { x + y }
+//! _ = max(/*x*/4, /*y*/4);
+//! ```
 use either::Either;
 use hir::{Callable, Semantics};
 use ide_db::{base_db::FileRange, RootDatabase};