Skip to content

Add docs for more crates #11177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Add docs for more crates #11177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ca1c34
Add docs for more crates
emberian Dec 28, 2013
e53e86a
Add a compiler-docs target
emberian Dec 29, 2013
7b382e5
Fix rustdoc bug involving PatLit
emberian Dec 29, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions mk/docs.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
######################################################################

DOCS :=
CDOCS :=
DOCS_L10N :=

BASE_DOC_OPTS := --from=markdown --standalone --toc --number-sections
Expand Down Expand Up @@ -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
Expand All @@ -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)

Expand Down
11 changes: 8 additions & 3 deletions src/librustdoc/clean.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 => ~"..",
Expand All @@ -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")
Expand Down