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

<!-- About self path error -->


`Self` is converted actual item ID, but not actual path.

So, the document with `Self` sometimes requires using `use` keyword.

# Examples


Documentation of following code generate _no_ warning.

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

    /// This enum has [`Self::Foo`].
    #[doc_share(doc)]
    pub enum MyEnum {
        Foo
    }
}

use my_mod::doc;
use my_mod::MyEnum;

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

pub type MyEnumAlias = MyEnum;
```

Documentation of following code generate warning.

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

    /// This enum has [`Self::Foo`]. // <---- ⚠️ Warning reason.
    #[doc_share(doc)]
    pub enum MyEnum {
        Foo
    }
}

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

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

pub type MyEnumAlias = my_mod::MyEnum; // <---- 👈 Full path is used.
```