diff options
| author | Corey Richardson <corey@octayn.net> | 2013-12-10 22:00:24 -0500 |
|---|---|---|
| committer | Corey Richardson <corey@octayn.net> | 2013-12-11 06:47:05 -0500 |
| commit | f0867e0ba2b91f31004167499cb10985f8362d36 (patch) | |
| tree | 834f898c25389737404e46cb9714144a0fa4724c | |
| parent | e08c9361207b083af091badbfe860d7bcf739157 (diff) | |
| download | rust-f0867e0ba2b91f31004167499cb10985f8362d36.tar.gz rust-f0867e0ba2b91f31004167499cb10985f8362d36.zip | |
Some rustdoc manual fixes
Clarify that it's sundown, and that we don't support magic
| -rw-r--r-- | doc/rustdoc.md | 19 | ||||
| -rw-r--r-- | doc/tutorial.md | 2 |
2 files changed, 18 insertions, 3 deletions
diff --git a/doc/rustdoc.md b/doc/rustdoc.md index 29ac2d2a2f3..705654211e2 100644 --- a/doc/rustdoc.md +++ b/doc/rustdoc.md @@ -38,8 +38,21 @@ pub fn recalibrate() { } ~~~ -Then, one can run `rustdoc universe.rs`. By default, it generates a directory -called `doc`, with the documentation for `universe` being in +Doc comments are markdown, and are currently parsed with the +[sundown][sundown] library. rustdoc does not yet do any fanciness such as +referencing other items inline, like javadoc's `@see`. One exception to this +is that the first paragrah will be used as the "summary" of an item in the +generated documentation: + +~~~ +/// A whizbang. Does stuff. (this line is the summary) +/// +/// Whizbangs are ... +struct Whizbang; +~~~ + +To generate the docs, run `rustdoc universe.rs`. By default, it generates a +directory called `doc`, with the documentation for `universe` being in `doc/universe/index.html`. If you are using other crates with `extern mod`, rustdoc will even link to them when you use their types, as long as their documentation has already been generated by a previous run of rustdoc, or the @@ -70,3 +83,5 @@ color, and one can always click on a colored type to jump to its documentation. There is a search bar at the top, which is powered by some javascript and a statically-generated search index. No special web server is required for the search. + +[sundown]: https://github.com/vmg/sundown/ diff --git a/doc/tutorial.md b/doc/tutorial.md index ae045581ad3..9e886067820 100644 --- a/doc/tutorial.md +++ b/doc/tutorial.md @@ -3235,7 +3235,7 @@ more out of date than this document. [container]: tutorial-container.html [conditions]: tutorial-conditions.html [rustpkg]: tutorial-rustpkg.html -[rustdoc]: tutorial-rustdoc.html +[rustdoc]: rustdoc.html [wiki]: https://github.com/mozilla/rust/wiki/Docs [wiki-packages]: https://github.com/mozilla/rust/wiki/Doc-packages,-editors,-and-other-tools |