]> git.lizzy.rs Git - rust.git/commitdiff
Rollup merge of #24754 - iliekturtles:patch-1, r=steveklabnik
authorManish Goregaokar <manishsmail@gmail.com>
Fri, 24 Apr 2015 04:20:16 +0000 (09:50 +0530)
committerManish Goregaokar <manishsmail@gmail.com>
Fri, 24 Apr 2015 04:20:16 +0000 (09:50 +0530)
1  2 
src/doc/reference.md

index 4e4b9c5bf6ebc8a6170f82809391b4777d87f063,bb9eeab24e7bd3048a24ddcbf8d7293bd3a0339a..0157dc7b3676bf7878887e07a5dae6cd47576d8d
@@@ -147,13 -147,11 +147,13 @@@ comments beginning with exactly one rep
  sequence (`/**`), are interpreted as a special syntax for `doc`
  [attributes](#attributes). That is, they are equivalent to writing
  `#[doc="..."]` around the body of the comment (this includes the comment
- characters themselves, ie `/// Foo` turns into `#[doc="/// Foo"]`).
+ characters themselves, i.e. `/// Foo` turns into `#[doc="/// Foo"]`).
  
 -`//!` comments apply to the parent of the comment, rather than the item that
 -follows. `//!` comments are usually used to display information on the crate
 -index page.
 +Line comments beginning with `//!` and block comments beginning with `/*!` are
 +doc comments that apply to the parent of the comment, rather than the item
 +that follows.  That is, they are equivalent to writing `#![doc="..."]` around
 +the body of the comment. `//!` comments are usually used to display
 +information on the crate index page.
  
  Non-doc comments are interpreted as a form of whitespace.