OpenE2K
/
rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

auto merge of #11177 : cmr/rust/native_and_green_docs, r=alexcrichton 

Some people have requested this, and I think it's quite useful to have
documentation for the compiler libraries. libnative and libgreen are
self-explanatory I think.
This commit is contained in:
bors 2013-12-28 21:36:59 -08:00
parent 38a5edbfe6 7b382e58b1
commit afe8f6e106
2 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
mk/docs.mk
View File

@ -13,6 +13,7 @@
######################################################################
DOCS :=
CDOCS :=
DOCS_L10N :=
BASE_DOC_OPTS := --from=markdown --standalone --toc --number-sections
@ -232,8 +233,21 @@ doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3))
DOCS += doc/$(1)/index.html
endef
define compiledoc
doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3))
@$$(call E, rustdoc: $$@)
$(Q)$(RUSTDOC) --cfg stage2 $(2)
CDOCS += doc/$(1)/index.html
endef
$(eval $(call libdoc,std,$(STDLIB_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,extra,$(EXTRALIB_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,native,$(LIBNATIVE_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,green,$(LIBGREEN_CRATE),$(CFG_BUILD)))
$(eval $(call compiledoc,rustc,$(COMPILER_CRATE),$(CFG_BUILD)))
$(eval $(call compiledoc,syntax,$(LIBSYNTAX_CRATE),$(CFG_BUILD)))
ifdef CFG_DISABLE_DOCS
@ -256,6 +270,7 @@ doc/version_info.html: version_info.html.template $(MKFILE_DEPS) \
GENERATED += doc/version.md doc/version_info.html
docs: $(DOCS)
compiler-docs: $(CDOCS)
docs-l10n: $(DOCS_L10N)

11
src/librustdoc/clean.rs
View File

@ -1123,6 +1123,8 @@ fn lit_to_str(lit: &ast::lit) -> ~str {
fn name_from_pat(p: &ast::Pat) -> ~str {
use syntax::ast::*;
debug!("Trying to get a name from pattern: {:?}", p);
match p.node {
PatWild => ~"_",
PatWildMulti => ~"..",
@ -1134,9 +1136,12 @@ fn name_from_pat(p: &ast::Pat) -> ~str {
PatBox(p) => name_from_pat(p),
PatUniq(p) => name_from_pat(p),
PatRegion(p) => name_from_pat(p),
PatLit(..) => fail!("tried to get argument name from pat_lit, \
which is not allowed in function arguments"),
PatRange(..) => fail!("tried to get argument name from pat_range, \
PatLit(..) => {
warn!("tried to get argument name from PatLit, \
which is silly in function arguments");
~"()"
},
PatRange(..) => fail!("tried to get argument name from PatRange, \
which is not allowed in function arguments"),
PatVec(..) => fail!("tried to get argument name from pat_vec, \
which is not allowed in function arguments")