just don't talk about inner doc comments

This commit is contained in:
Steve Klabnik 2015-12-29 17:34:24 -05:00
parent f6534b1754
commit db59879a46

View File

@ -77,10 +77,3 @@ src/main.rs:1:1: 1:27 error: expected item after doc comment
src/main.rs:1 /// What am I documenting?
^~~~~~~~~~~~~~~~~~~~~~~~~~
```
### Inner documentation comments
There is a secondary form of a documentation comment, an inner documentation
comment. Inner documentation comments look like this: `//!`. They are only
really used to document modules, however, and so we will talk about them in the
modules section.