Extract description of module items as HTML

Previously, we only showed plain text versions of the item descriptions
in the module overview due to a formatting issue.  As this issue
disappeared, we can now use the HTML version of the description.
This commit is contained in:
Robin Krahl 2020-07-26 12:12:50 +02:00
parent 6ca9d90e46
commit ae0a741d5a
No known key found for this signature in database
GPG Key ID: 8E9B0870524F69D8
2 changed files with 2 additions and 3 deletions

View File

@ -14,6 +14,7 @@ SPDX-License-Identifier: MIT
- Remove spurious members in module documentation.
- Show the definition for constants and typedefs.
- Fix group and ID for typdef items.
- Extract the description of module items as HTML instead of plain text.
## v0.1.2 (2020-07-25)

View File

@ -500,9 +500,7 @@ fn get_members(
let docblock = item.as_node().parent().and_then(|n| n.next_sibling());
let mut doc = doc::Doc::new(parent.name.child(&item_name), ty);
// We would like to use inner_html() here, but that is currently not implemented in
// kuchiki
doc.description = docblock.map(|n| n.text_contents());
doc.description = docblock.map(|n| get_html(&n)).transpose()?;
members.push(doc);
}
}