diff options
| author | Gareth Daniel Smith <garethdanielsmith@gmail.com> | 2012-07-04 22:53:12 +0100 |
|---|---|---|
| committer | Brian Anderson <banderson@mozilla.com> | 2012-07-04 19:18:13 -0700 |
| commit | be0141666dd12316034499db12ee9fcf9ba648dd (patch) | |
| tree | 7d4c985a73e9a85de0e6c1bf2beeed44ebbd0102 /src/rustdoc/config.rs | |
| parent | bfa43ca3011bd1296cb1797ad3ea1c5dc4056749 (diff) | |
| download | rust-be0141666dd12316034499db12ee9fcf9ba648dd.tar.gz rust-be0141666dd12316034499db12ee9fcf9ba648dd.zip | |
convert doc-attributes to doc-comments using ./src/etc/sugarise-doc-comments.py (and manually tweaking) - for issue #2498
Diffstat (limited to 'src/rustdoc/config.rs')
| -rw-r--r-- | src/rustdoc/config.rs | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/rustdoc/config.rs b/src/rustdoc/config.rs index c316b175e66..94d23277867 100644 --- a/src/rustdoc/config.rs +++ b/src/rustdoc/config.rs @@ -8,23 +8,23 @@ export default_config; export parse_config; export usage; -#[doc = "The type of document to output"] +/// The type of document to output enum output_format { - #[doc = "Markdown"] + /// Markdown markdown, - #[doc = "HTML, via markdown and pandoc"] + /// HTML, via markdown and pandoc pandoc_html } -#[doc = "How to organize the output"] +/// How to organize the output enum output_style { - #[doc = "All in a single document"] + /// All in a single document doc_per_crate, - #[doc = "Each module in its own document"] + /// Each module in its own document doc_per_mod } -#[doc = "The configuration for a rustdoc session"] +/// The configuration for a rustdoc session type config = { input_crate: str, output_dir: str, |
