diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/rustdoc/astsrv.rs | 16 | ||||
| -rw-r--r-- | src/rustdoc/attr_parser.rs | 12 | ||||
| -rw-r--r-- | src/rustdoc/attr_pass.rs | 14 | ||||
| -rw-r--r-- | src/rustdoc/desc_to_brief_pass.rs | 10 | ||||
| -rw-r--r-- | src/rustdoc/page_pass.rs | 10 | ||||
| -rwxr-xr-x | src/rustdoc/rustdoc.rs | 3 | ||||
| -rw-r--r-- | src/rustdoc/trim_pass.rs | 10 | ||||
| -rw-r--r-- | src/rustdoc/unindent_pass.rs | 18 |
8 files changed, 47 insertions, 46 deletions
diff --git a/src/rustdoc/astsrv.rs b/src/rustdoc/astsrv.rs index b0edb14f999..2ae641a73bb 100644 --- a/src/rustdoc/astsrv.rs +++ b/src/rustdoc/astsrv.rs @@ -1,11 +1,11 @@ -#[doc( - brief = "Provides all access to AST-related, non-sendable info", - desc = - "Rustdoc is intended to be parallel, and the rustc AST is filled \ - with shared boxes. The AST service attempts to provide a single \ - place to query AST-related information, shielding the rest of \ - Rustdoc from its non-sendableness." -)]; +/*! +Provides all access to AST-related, non-sendable info + +Rustdoc is intended to be parallel, and the rustc AST is filled with +shared boxes. The AST service attempts to provide a single place to +query AST-related information, shielding the rest of Rustdoc from its +non-sendableness. +*/ use std::map::HashMap; use rustc::driver::session; diff --git a/src/rustdoc/attr_parser.rs b/src/rustdoc/attr_parser.rs index 073223617ef..e3522c9b4d7 100644 --- a/src/rustdoc/attr_parser.rs +++ b/src/rustdoc/attr_parser.rs @@ -1,9 +1,9 @@ -#[doc( - brief = "Attribute parsing", - desc = - "The attribute parser provides methods for pulling documentation out of \ - an AST's attributes." -)]; +/*! +Attribute parsing + +The attribute parser provides methods for pulling documentation out of +an AST's attributes. +*/ use syntax::ast; use syntax::attr; diff --git a/src/rustdoc/attr_pass.rs b/src/rustdoc/attr_pass.rs index 354332db0ff..ea049e0d9fc 100644 --- a/src/rustdoc/attr_pass.rs +++ b/src/rustdoc/attr_pass.rs @@ -1,10 +1,10 @@ -#[doc( - brief = "The attribute parsing pass", - desc = - "Traverses the document tree, pulling relevant documention out of the \ - corresponding AST nodes. The information gathered here is the basis \ - of the natural-language documentation for a crate." -)]; +/*! +The attribute parsing pass + +Traverses the document tree, pulling relevant documention out of the +corresponding AST nodes. The information gathered here is the basis +of the natural-language documentation for a crate. +*/ use doc::ItemUtils; use extract::to_str; diff --git a/src/rustdoc/desc_to_brief_pass.rs b/src/rustdoc/desc_to_brief_pass.rs index 27548f40dfd..7e08ce711e7 100644 --- a/src/rustdoc/desc_to_brief_pass.rs +++ b/src/rustdoc/desc_to_brief_pass.rs @@ -1,9 +1,9 @@ /*! - * Pulls a brief description out of a long description. - * - * If the first paragraph of a long description is short enough then it - * is interpreted as the brief description. - */ +Pulls a brief description out of a long description. + +If the first paragraph of a long description is short enough then it +is interpreted as the brief description. +*/ use doc::ItemUtils; diff --git a/src/rustdoc/page_pass.rs b/src/rustdoc/page_pass.rs index d67c615f629..f9f3d3c9e1e 100644 --- a/src/rustdoc/page_pass.rs +++ b/src/rustdoc/page_pass.rs @@ -1,9 +1,9 @@ /*! - * Divides the document tree into pages. - * - * Each page corresponds is a logical section. There may be pages for - * individual modules, pages for the crate, indexes, etc. - */ +Divides the document tree into pages. + +Each page corresponds is a logical section. There may be pages for +individual modules, pages for the crate, indexes, etc. +*/ use doc::{ItemUtils, PageUtils}; use syntax::ast; diff --git a/src/rustdoc/rustdoc.rs b/src/rustdoc/rustdoc.rs index 7816d788e33..b86955afb00 100755 --- a/src/rustdoc/rustdoc.rs +++ b/src/rustdoc/rustdoc.rs @@ -1,4 +1,5 @@ -// Some utility interfaces +//! Some utility interfaces + use doc::ItemUtils; use doc::Item; use doc::util; diff --git a/src/rustdoc/trim_pass.rs b/src/rustdoc/trim_pass.rs index dcbda1af9f6..b611551d23b 100644 --- a/src/rustdoc/trim_pass.rs +++ b/src/rustdoc/trim_pass.rs @@ -1,9 +1,9 @@ /*! - * Pulls a brief description out of a long description. - * - * If the first paragraph of a long description is short enough then it - * is interpreted as the brief description. - */ +Pulls a brief description out of a long description. + +If the first paragraph of a long description is short enough then it +is interpreted as the brief description. +*/ use doc::ItemUtils; diff --git a/src/rustdoc/unindent_pass.rs b/src/rustdoc/unindent_pass.rs index e650b8eb907..42c9e80ab7b 100644 --- a/src/rustdoc/unindent_pass.rs +++ b/src/rustdoc/unindent_pass.rs @@ -1,13 +1,13 @@ /*! - * Removes the common level of indention from description strings. For - * instance, if an entire doc comment is indented 8 spaces we want to - * remove those 8 spaces from every line. - * - * The first line of a string is allowed to be intend less than - * subsequent lines in the same paragraph in order to account for - * instances where the string containing the doc comment is opened in the - * middle of a line, and each of the following lines is indented. - */ +Removes the common level of indention from description strings. For +instance, if an entire doc comment is indented 8 spaces we want to +remove those 8 spaces from every line. + +The first line of a string is allowed to be intend less than +subsequent lines in the same paragraph in order to account for +instances where the string containing the doc comment is opened in the +middle of a line, and each of the following lines is indented. +*/ export mk_pass; |
