diff options
Diffstat (limited to 'src/librustdoc/markdown_pass.rs')
| -rw-r--r-- | src/librustdoc/markdown_pass.rs | 94 |
1 files changed, 47 insertions, 47 deletions
diff --git a/src/librustdoc/markdown_pass.rs b/src/librustdoc/markdown_pass.rs index d1ae5d4ecf3..a6be38b4eb4 100644 --- a/src/librustdoc/markdown_pass.rs +++ b/src/librustdoc/markdown_pass.rs @@ -41,9 +41,9 @@ use core::vec; use std::par; use syntax; -pub fn mk_pass(+writer_factory: WriterFactory) -> Pass { +pub fn mk_pass(writer_factory: WriterFactory) -> Pass { let f = fn~(move writer_factory, - srv: astsrv::Srv, +doc: doc::Doc) -> doc::Doc { + srv: astsrv::Srv, doc: doc::Doc) -> doc::Doc { run(srv, doc, copy writer_factory) }; @@ -55,8 +55,8 @@ pub fn mk_pass(+writer_factory: WriterFactory) -> Pass { fn run( srv: astsrv::Srv, - +doc: doc::Doc, - +writer_factory: WriterFactory + doc: doc::Doc, + writer_factory: WriterFactory ) -> doc::Doc { pure fn mods_last(item1: &doc::ItemTag, item2: &doc::ItemTag) -> bool { @@ -115,8 +115,8 @@ type Ctxt = { }; pub fn write_markdown( - +doc: doc::Doc, - +writer_factory: WriterFactory + doc: doc::Doc, + writer_factory: WriterFactory ) { // There is easy parallelism to be had here, but // we don't want to spawn too many pandoc processes. @@ -159,12 +159,12 @@ fn should_request_new_writer_for_each_page() { } } -fn write_title(ctxt: &Ctxt, +page: doc::Page) { +fn write_title(ctxt: &Ctxt, page: doc::Page) { ctxt.w.write_line(fmt!("%% %s", make_title(page))); ctxt.w.write_line(~""); } -fn make_title(+page: doc::Page) -> ~str { +fn make_title(page: doc::Page) -> ~str { let item = match page { doc::CratePage(CrateDoc) => { doc::ModTag(copy CrateDoc.topmod) @@ -205,18 +205,18 @@ enum Hlvl { H4 = 4 } -fn write_header(ctxt: &Ctxt, lvl: Hlvl, +doc: doc::ItemTag) { +fn write_header(ctxt: &Ctxt, lvl: Hlvl, doc: doc::ItemTag) { let text = header_text(doc); write_header_(ctxt, lvl, text); } -fn write_header_(ctxt: &Ctxt, lvl: Hlvl, +title: ~str) { +fn write_header_(ctxt: &Ctxt, lvl: Hlvl, title: ~str) { let hashes = str::from_chars(vec::from_elem(lvl as uint, '#')); ctxt.w.write_line(fmt!("%s %s", hashes, title)); ctxt.w.write_line(~""); } -pub fn header_kind(+doc: doc::ItemTag) -> ~str { +pub fn header_kind(doc: doc::ItemTag) -> ~str { match doc { doc::ModTag(_) => { if doc.id() == syntax::ast::crate_node_id { @@ -252,7 +252,7 @@ pub fn header_kind(+doc: doc::ItemTag) -> ~str { } } -pub fn header_name(+doc: doc::ItemTag) -> ~str { +pub fn header_name(doc: doc::ItemTag) -> ~str { let fullpath = str::connect(doc.path() + ~[doc.name()], ~"::"); match &doc { &doc::ModTag(_) if doc.id() != syntax::ast::crate_node_id => { @@ -281,7 +281,7 @@ pub fn header_name(+doc: doc::ItemTag) -> ~str { } } -pub fn header_text(+doc: doc::ItemTag) -> ~str { +pub fn header_text(doc: doc::ItemTag) -> ~str { match &doc { &doc::ImplTag(ref ImplDoc) => { let header_kind = header_kind(copy doc); @@ -305,21 +305,21 @@ fn header_text_(kind: &str, name: &str) -> ~str { fn write_crate( ctxt: &Ctxt, - +doc: doc::CrateDoc + doc: doc::CrateDoc ) { write_top_module(ctxt, copy doc.topmod); } fn write_top_module( ctxt: &Ctxt, - +ModDoc: doc::ModDoc + ModDoc: doc::ModDoc ) { write_mod_contents(ctxt, ModDoc); } fn write_mod( ctxt: &Ctxt, - +ModDoc: doc::ModDoc + ModDoc: doc::ModDoc ) { write_mod_contents(ctxt, ModDoc); } @@ -332,7 +332,7 @@ fn should_write_full_path_to_mod() { fn write_oldcommon( ctxt: &Ctxt, - +desc: Option<~str>, + desc: Option<~str>, sections: &[doc::Section] ) { write_desc(ctxt, desc); @@ -341,7 +341,7 @@ fn write_oldcommon( fn write_desc( ctxt: &Ctxt, - +desc: Option<~str> + desc: Option<~str> ) { match desc { Some(desc) => { @@ -358,7 +358,7 @@ fn write_sections(ctxt: &Ctxt, sections: &[doc::Section]) { } } -fn write_section(ctxt: &Ctxt, +section: doc::Section) { +fn write_section(ctxt: &Ctxt, section: doc::Section) { write_header_(ctxt, H4, copy section.header); ctxt.w.write_line(copy section.body); ctxt.w.write_line(~""); @@ -377,7 +377,7 @@ fn should_write_sections() { fn write_mod_contents( ctxt: &Ctxt, - +doc: doc::ModDoc + doc: doc::ModDoc ) { write_oldcommon(ctxt, doc.desc(), doc.sections()); if doc.index.is_some() { @@ -389,15 +389,15 @@ fn write_mod_contents( } } -fn write_item(ctxt: &Ctxt, +doc: doc::ItemTag) { +fn write_item(ctxt: &Ctxt, doc: doc::ItemTag) { write_item_(ctxt, doc, true); } -fn write_item_no_header(ctxt: &Ctxt, +doc: doc::ItemTag) { +fn write_item_no_header(ctxt: &Ctxt, doc: doc::ItemTag) { write_item_(ctxt, doc, false); } -fn write_item_(ctxt: &Ctxt, +doc: doc::ItemTag, write_header: bool) { +fn write_item_(ctxt: &Ctxt, doc: doc::ItemTag, write_header: bool) { if write_header { write_item_header(ctxt, copy doc); } @@ -415,13 +415,13 @@ fn write_item_(ctxt: &Ctxt, +doc: doc::ItemTag, write_header: bool) { } } -fn write_item_header(ctxt: &Ctxt, +doc: doc::ItemTag) { - write_header(ctxt, item_header_lvl(doc), doc); +fn write_item_header(ctxt: &Ctxt, doc: doc::ItemTag) { + write_header(ctxt, item_header_lvl(&doc), doc); } -fn item_header_lvl(+doc: doc::ItemTag) -> Hlvl { +fn item_header_lvl(doc: &doc::ItemTag) -> Hlvl { match doc { - doc::ModTag(_) | doc::NmodTag(_) => H1, + &doc::ModTag(_) | &doc::NmodTag(_) => H1, _ => H2 } } @@ -432,7 +432,7 @@ fn should_write_crate_description() { assert str::contains(markdown, ~"this is the crate"); } -fn write_index(ctxt: &Ctxt, +index: doc::Index) { +fn write_index(ctxt: &Ctxt, index: doc::Index) { if vec::is_empty(index.entries) { return; } @@ -481,7 +481,7 @@ fn should_write_index_for_foreign_mods() { ); } -fn write_nmod(ctxt: &Ctxt, +doc: doc::NmodDoc) { +fn write_nmod(ctxt: &Ctxt, doc: doc::NmodDoc) { write_oldcommon(ctxt, doc.desc(), doc.sections()); if doc.index.is_some() { write_index(ctxt, (&doc.index).get()); @@ -516,7 +516,7 @@ fn should_write_foreign_fn_headers() { fn write_fn( ctxt: &Ctxt, - +doc: doc::FnDoc + doc: doc::FnDoc ) { write_fnlike( ctxt, @@ -528,15 +528,15 @@ fn write_fn( fn write_fnlike( ctxt: &Ctxt, - +sig: Option<~str>, - +desc: Option<~str>, + sig: Option<~str>, + desc: Option<~str>, sections: &[doc::Section] ) { write_sig(ctxt, sig); write_oldcommon(ctxt, desc, sections); } -fn write_sig(ctxt: &Ctxt, +sig: Option<~str>) { +fn write_sig(ctxt: &Ctxt, sig: Option<~str>) { match sig { Some(sig) => { ctxt.w.write_line(code_block_indent(sig)); @@ -546,7 +546,7 @@ fn write_sig(ctxt: &Ctxt, +sig: Option<~str>) { } } -fn code_block_indent(+s: ~str) -> ~str { +fn code_block_indent(s: ~str) -> ~str { let lines = str::lines_any(s); let indented = vec::map(lines, |line| fmt!(" %s", *line) ); str::connect(indented, ~"\n") @@ -599,7 +599,7 @@ fn should_leave_blank_line_between_fn_header_and_sig() { fn write_const( ctxt: &Ctxt, - +doc: doc::ConstDoc + doc: doc::ConstDoc ) { write_sig(ctxt, copy doc.sig); write_oldcommon(ctxt, doc.desc(), doc.sections()); @@ -621,7 +621,7 @@ fn should_write_const_description() { fn write_enum( ctxt: &Ctxt, - +doc: doc::EnumDoc + doc: doc::EnumDoc ) { write_oldcommon(ctxt, doc.desc(), doc.sections()); write_variants(ctxt, doc.variants); @@ -657,7 +657,7 @@ fn write_variants( ctxt.w.write_line(~""); } -fn write_variant(ctxt: &Ctxt, +doc: doc::VariantDoc) { +fn write_variant(ctxt: &Ctxt, doc: doc::VariantDoc) { assert doc.sig.is_some(); let sig = (&doc.sig).get(); match copy doc.desc { @@ -703,7 +703,7 @@ fn should_write_variant_list_with_signatures() { \n* `c(int)` - a\n\n"); } -fn write_trait(ctxt: &Ctxt, +doc: doc::TraitDoc) { +fn write_trait(ctxt: &Ctxt, doc: doc::TraitDoc) { write_oldcommon(ctxt, doc.desc(), doc.sections()); write_methods(ctxt, doc.methods); } @@ -714,7 +714,7 @@ fn write_methods(ctxt: &Ctxt, docs: &[doc::MethodDoc]) { } } -fn write_method(ctxt: &Ctxt, +doc: doc::MethodDoc) { +fn write_method(ctxt: &Ctxt, doc: doc::MethodDoc) { write_header_(ctxt, H3, header_text_(~"Method", doc.name)); write_fnlike( ctxt, @@ -751,7 +751,7 @@ fn should_write_trait_method_signature() { assert str::contains(markdown, ~"\n fn a()"); } -fn write_impl(ctxt: &Ctxt, +doc: doc::ImplDoc) { +fn write_impl(ctxt: &Ctxt, doc: doc::ImplDoc) { write_oldcommon(ctxt, doc.desc(), doc.sections()); write_methods(ctxt, doc.methods); } @@ -791,7 +791,7 @@ fn should_write_impl_method_signature() { fn write_type( ctxt: &Ctxt, - +doc: doc::TyDoc + doc: doc::TyDoc ) { write_sig(ctxt, copy doc.sig); write_oldcommon(ctxt, doc.desc(), doc.sections()); @@ -818,7 +818,7 @@ fn should_write_type_signature() { fn write_struct( ctxt: &Ctxt, - +doc: doc::StructDoc + doc: doc::StructDoc ) { write_sig(ctxt, copy doc.sig); write_oldcommon(ctxt, doc.desc(), doc.sections()); @@ -851,14 +851,14 @@ mod test { use core::path::Path; use core::str; - pub fn render(+source: ~str) -> ~str { + pub fn render(source: ~str) -> ~str { let (srv, doc) = create_doc_srv(source); let markdown = write_markdown_str_srv(srv, doc); debug!("markdown: %s", markdown); markdown } - pub fn create_doc_srv(+source: ~str) -> (astsrv::Srv, doc::Doc) { + pub fn create_doc_srv(source: ~str) -> (astsrv::Srv, doc::Doc) { do astsrv::from_str(source) |srv| { let config = config::Config { @@ -888,13 +888,13 @@ mod test { } } - pub fn create_doc(+source: ~str) -> doc::Doc { + pub fn create_doc(source: ~str) -> doc::Doc { let (_, doc) = create_doc_srv(source); doc } pub fn write_markdown_str( - +doc: doc::Doc + doc: doc::Doc ) -> ~str { let (writer_factory, po) = markdown_writer::future_writer_factory(); write_markdown(doc, move writer_factory); @@ -903,7 +903,7 @@ mod test { pub fn write_markdown_str_srv( srv: astsrv::Srv, - +doc: doc::Doc + doc: doc::Doc ) -> ~str { let (writer_factory, po) = markdown_writer::future_writer_factory(); let pass = mk_pass(move writer_factory); |
