@@ -9,7 +9,7 @@ These commands will appropriately invoke `rustdoc` (and `rustc`) as required.
9
9
### Doc comments
10
10
11
11
Doc comments are very useful for big projects that require documentation. When
12
- running Rustdoc , these are the comments that get compiled into
12
+ running ` rustdoc ` , these are the comments that get compiled into
13
13
documentation. They are denoted by a ` /// ` , and support [ Markdown] .
14
14
15
15
``` rust,editable,ignore
@@ -32,7 +32,7 @@ impl Person {
32
32
///
33
33
/// ```
34
34
/// // You can have rust code between fences inside the comments
35
- /// // If you pass --test to Rustdoc , it will even test it for you!
35
+ /// // If you pass --test to `rustdoc` , it will even test it for you!
36
36
/// use doc::Person;
37
37
/// let person = Person::new("name");
38
38
/// ```
@@ -57,7 +57,7 @@ fn main() {
57
57
}
58
58
```
59
59
60
- To run the tests, first build the code as a library, then tell rustdoc where
60
+ To run the tests, first build the code as a library, then tell ` rustdoc ` where
61
61
to find the library so it can link it into each doctest program:
62
62
63
63
``` shell
@@ -68,7 +68,7 @@ $ rustdoc --test --extern doc="libdoc.rlib" doc.rs
68
68
### See also:
69
69
70
70
* [ The Rust Book: Making Useful Documentation Comments] [ book ]
71
- * [ The Rustdoc Book] [ rustdoc-book ]
71
+ * [ The rustdoc Book] [ rustdoc-book ]
72
72
* [ The Reference: Doc comments] [ ref-comments ]
73
73
* [ RFC 1574: API Documentation Conventions] [ api-conv ]
74
74
* [ RFC 1946: Relative links to other items from doc comments (intra-rustdoc links)] [ intra-links ]
0 commit comments