Skip to content

Commit 50d8e9f

Browse files
committed
Revert "rustdoc: Get the crate brief description from the 'desc' attr"
This reverts commit 521e58a. Some crates use 'desc', some 'comment' - I want them to just use 'doc'
1 parent f4c31bd commit 50d8e9f

File tree

3 files changed

+5
-35
lines changed

3 files changed

+5
-35
lines changed

src/rustdoc/attr_parser.rs

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ export crate_attrs, mod_attrs, fn_attrs, arg_attrs;
1313
export parse_crate, parse_mod, parse_fn;
1414

1515
type crate_attrs = {
16-
name: option<str>,
17-
desc: option<str>
16+
name: option<str>
1817
};
1918

2019
type mod_attrs = {
@@ -56,11 +55,9 @@ fn doc_meta(
5655

5756
fn parse_crate(attrs: [ast::attribute]) -> crate_attrs {
5857
let link_metas = attr::find_linkage_metas(attrs);
59-
let attr_metas = attr::attr_metas(attrs);
6058

6159
{
62-
name: attr::meta_item_value_from_list(link_metas, "name"),
63-
desc: attr::meta_item_value_from_list(attr_metas, "desc")
60+
name: attr::meta_item_value_from_list(link_metas, "name")
6461
}
6562
}
6663

@@ -88,14 +85,6 @@ fn should_not_extract_crate_name_if_no_name_value_in_link_attribute() {
8885
assert attrs.name == none;
8986
}
9087

91-
#[test]
92-
fn should_extract_crate_desc() {
93-
let source = "#[desc = \"Teddybears\"]";
94-
let attrs = test::parse_attributes(source);
95-
let attrs = parse_crate(attrs);
96-
assert attrs.desc == some("Teddybears");
97-
}
98-
9988
fn parse_mod(attrs: [ast::attribute]) -> mod_attrs {
10089
parse_short_doc_or(
10190
attrs,

src/rustdoc/attr_pass.rs

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,14 @@ fn fold_crate(
3636
let srv = fold.ctxt;
3737
let doc = fold::default_seq_fold_crate(fold, doc);
3838

39-
// Use various crate attributes to set documentation on the top mod
40-
4139
let attrs = astsrv::exec(srv) {|ctxt|
4240
let attrs = ctxt.ast.node.attrs;
4341
attr_parser::parse_crate(attrs)
4442
};
4543

46-
let brief = option::maybe(doc.topmod.brief, attrs.desc) {|desc|
47-
if option::is_some(doc.topmod.brief) {
48-
#warn("overriding crate brief doc attribute \
49-
with crate description");
50-
}
51-
some(desc)
52-
};
53-
5444
~{
5545
topmod: ~{
56-
name: option::from_maybe(doc.topmod.name, attrs.name),
57-
brief: brief
46+
name: option::from_maybe(doc.topmod.name, attrs.name)
5847
with *doc.topmod
5948
}
6049
}
@@ -70,16 +59,6 @@ fn should_replace_top_module_name_with_crate_name() {
7059
assert doc.topmod.name == "bond";
7160
}
7261

73-
#[test]
74-
fn should_replace_top_module_brief_with_crate_desc() {
75-
let source = "#[desc = \"The Rust compiler\"];";
76-
let srv = astsrv::mk_srv_from_str(source);
77-
let doc = extract::from_srv(srv, "");
78-
let fold = fold::default_seq_fold(srv);
79-
let doc = fold_crate(fold, doc);
80-
assert doc.topmod.brief == some("The Rust compiler");
81-
}
82-
8362
fn fold_mod(fold: fold::fold<astsrv::srv>, doc: doc::moddoc) -> doc::moddoc {
8463
let srv = fold.ctxt;
8564
let attrs = if doc.id == ast::crate_node_id {

src/rustdoc/rustdoc.rc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
#[doc = "Rustdoc - The Rust documentation generator"];
2+
13
#[link(name = "rustdoc",
24
vers = "0.1",
35
uuid = "f8abd014-b281-484d-a0c3-26e3de8e2412",

0 commit comments

Comments
 (0)