rustdoc_copy 0.2.0

Rustdoc comment copy helper.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

<!-- About normal path error -->


The path of root module for documentation
must be accessible without preceding paths.

In other words, if that identifier is in
another module, `use` keyword is required.

# Examples


Compilation of following code will success.

```rust
pub mod my_mod {
    use rustdoc_copy::prelude::*;

    /// This is my function.
    #[doc_share(doc)]
    pub fn my_func() {
        println!("`my_func` is called.");
    }
}

use my_mod::doc;

#[doc = doc::all!()]

pub fn my_func_alias() {
    my_mod::my_func();
}
```

Compilation of following code cause error.

```rust, compile_fail
pub mod my_mod {
    use rustdoc_copy::prelude::*;

    /// This is my function.
    #[doc_share(doc)] // <---- ❌ Error detected.
    pub fn my_func() {
        println!("`my_func` is called.");
    }
}

// use my_mod::doc; // <---- 🚧 Shorthand path is not used.

#[doc = my_mod::doc::all!()] // <---- 👈 Full path is used.

pub fn my_func_alias() {
    my_mod::my_func();
}
```