Commit b8313df

committed

rustdoc: render attributes in Field and Variants sections

1 parent 4eedad3 commit b8313dfCopy full SHA for b8313df

File tree

3 files changed

+26

-4

lines changed

src/librustdoc/html
- render
  - print_item.rs
- templates
  - item_union.html
tests/rustdoc
- attributes.rs

3 files changed

+26

-4

lines changed

`‎src/librustdoc/html/render/print_item.rs‎`

Lines changed: 21 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1460,6 +1460,13 @@ impl<'a, 'cx: 'a> ItemUnion<'a, 'cx> {`
`1460`	`1460`	`)`
`1461`	`1461`	`}`
`1462`	`1462`
	`1463`	`+ fn print_field_attrs(&self, field: &'a clean::Item) -> impl Display {`
	`1464`	`+ fmt::from_fn(move \|w\| {`
	`1465`	`+ render_attributes_in_code(w, field, "", self.cx);`
	`1466`	`+ Ok(())`
	`1467`	`+ })`
	`1468`	`+ }`
	`1469`	`+`
`1463`	`1470`	`fn document_field(&self, field: &'a clean::Item) -> impl Display {`
`1464`	`1471`	`document(self.cx, field, Some(self.it), HeadingOffset::H3)`
`1465`	`1472`	`}`
`@@ -1770,6 +1777,7 @@ fn item_variants(`
`1770`	`1777`	`)`
`1771`	`1778`	`.maybe_display()`
`1772`	`1779`	`)?;`
	`1780`	`+ render_attributes_in_code(w, variant, "", cx);`
`1773`	`1781`	`if let clean::VariantItem(ref var) = variant.kind`
`1774`	`1782`	`&& let clean::VariantKind::CLike = var.kind`
`1775`	`1783`	`{`
`@@ -1843,7 +1851,12 @@ fn item_variants(`
`1843`	`1851`	`"<div class=\"sub-variant-field\">\`
`1844`	`1852`	`<span id=\"{id}\" class=\"section-header\">\`
`1845`	`1853`	`<a href=\"#{id}\" class=\"anchor field\">§</a>\`
`1846`		`- <code>{f}: {t}</code>\`
	`1854`	`+ <code>"`
	`1855`	`+ )?;`
	`1856`	`+ render_attributes_in_code(w, field, "", cx);`
	`1857`	`+ write!(`
	`1858`	`+ w,`
	`1859`	`+ "{f}: {t}</code>\`
`1847`	`1860`	`</span>\`
`1848`	`1861`	`{doc}\`
`1849`	`1862`	`</div>",`
`@@ -2079,10 +2092,15 @@ fn item_fields(`
`2079`	`2092`	`w,`
`2080`	`2093`	`"<span id=\"{id}\" class=\"{item_type} section-header\">\`
`2081`	`2094`	`<a href=\"#{id}\" class=\"anchor field\">§</a>\`
`2082`		`- <code>{field_name}: {ty}</code>\`
	`2095`	`+ <code>",`
	`2096`	`+ item_type = ItemType::StructField,`
	`2097`	`+ )?;`
	`2098`	`+ render_attributes_in_code(w, field, "", cx);`
	`2099`	`+ write!(`
	`2100`	`+ w,`
	`2101`	`+ "{field_name}: {ty}</code>\`
`2083`	`2102`	`</span>\`
`2084`	`2103`	`{doc}",`
`2085`		`- item_type = ItemType::StructField,`
`2086`	`2104`	`ty = ty.print(cx),`
`2087`	`2105`	`doc = document(cx, field, Some(it), HeadingOffset::H3),`
`2088`	`2106`	`)?;`

`‎src/librustdoc/html/templates/item_union.html‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ <h2 id="fields" class="fields section-header"> {# #}`
`12`	`12`	`{% let name = field.name.expect("union field name") %}`
`13`	`13`	`<span id="structfield.{{ name }}" class="{{ ItemType::StructField +}} section-header"> {# #}`
`14`	`14`	`<a href="#structfield.{{ name }}" class="anchor field">§</a> {# #}`
`15`		`- <code>{{ name }}: {{+ self.print_ty(ty)\|safe }}</code> {# #}`
	`15`	`+ <code>{{+ self.print_field_attrs(field)\|safe }}{{ name }}: {{+ self.print_ty(ty)\|safe }}</code> {# #}`
`16`	`16`	`</span>`
`17`	`17`	`{% if let Some(stability_class) = self.stability_field(field) %}`
`18`	`18`	`<span class="stab {{ stability_class }}"></span>`

`‎tests/rustdoc/attributes.rs‎`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -28,12 +28,15 @@ macro_rules! macro_rule {`
`28`	`28`	`#[unsafe(link_section = "enum")]`
`29`	`29`	`pub enum Enum {`
`30`	`30`	`//@ has 'foo/enum.Enum.html' '//*[@class="code-attribute"]' '#[unsafe(link_section = "a")]'`
	`31`	`+ //@ has - '//[@class="variants"]//[@class="code-attribute"]' '#[unsafe(link_section = "a")]'`
`31`	`32`	`#[unsafe(link_section = "a")]`
`32`	`33`	`A,`
`33`	`34`	`//@ has 'foo/enum.Enum.html' '//*[@class="code-attribute"]' '#[unsafe(link_section = "quz")]'`
	`35`	`+ //@ has - '//[@class="variants"]//[@class="code-attribute"]' '#[unsafe(link_section = "quz")]'`
`34`	`36`	`#[unsafe(link_section = "quz")]`
`35`	`37`	`Quz {`
`36`	`38`	`//@ has 'foo/enum.Enum.html' '//*[@class="code-attribute"]' '#[unsafe(link_section = "b")]'`
	`39`	`+ //@ has - '//[@class="variants"]//[@class="code-attribute"]' '#[unsafe(link_section = "b")]'`
`37`	`40`	`#[unsafe(link_section = "b")]`
`38`	`41`	`b: (),`
`39`	`42`	`},`
`@@ -66,6 +69,7 @@ pub union Union {`
`66`	`69`	`#[unsafe(link_section = "struct")]`
`67`	`70`	`pub struct Struct {`
`68`	`71`	`//@ has 'foo/struct.Struct.html' '//*[@class="code-attribute"]' '#[unsafe(link_section = "x")]'`
	`72`	`+ //@ has - '//[@id="structfield.x"]//[@class="code-attribute"]' '#[unsafe(link_section = "x")]'`
`69`	`73`	`#[unsafe(link_section = "x")]`
`70`	`74`	`pub x: u32,`
`71`	`75`	`y: f32,`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit b8313df

File tree

3 files changed

3 files changed

`‎src/librustdoc/html/render/print_item.rs‎`

`‎src/librustdoc/html/templates/item_union.html‎`

`‎tests/rustdoc/attributes.rs‎`

0 commit comments