@@ -38,8 +38,21 @@ pub fn recalibrate() {
3838}
3939~~~
4040
41- Then, one can run ` rustdoc universe.rs ` . By default, it generates a directory
42- called ` doc ` , with the documentation for ` universe ` being in
41+ Doc comments are markdown, and are currently parsed with the
42+ [ sundown] [ sundown ] library. rustdoc does not yet do any fanciness such as
43+ referencing other items inline, like javadoc's ` @see ` . One exception to this
44+ is that the first paragrah will be used as the "summary" of an item in the
45+ generated documentation:
46+
47+ ~~~
48+ /// A whizbang. Does stuff. (this line is the summary)
49+ ///
50+ /// Whizbangs are ...
51+ struct Whizbang;
52+ ~~~
53+
54+ To generate the docs, run ` rustdoc universe.rs ` . By default, it generates a
55+ directory called ` doc ` , with the documentation for ` universe ` being in
4356` doc/universe/index.html ` . If you are using other crates with ` extern mod ` ,
4457rustdoc will even link to them when you use their types, as long as their
4558documentation 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
7083documentation. There is a search bar at the top, which is powered by some
7184javascript and a statically-generated search index. No special web server is
7285required for the search.
86+
87+ [ sundown ] : https://github.com/vmg/sundown/
0 commit comments