Skip to content

rustdoc: add option to calculate "documentation coverage" #58626

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

Merged
bors merged 14 commits into from
Mar 9, 2019
Merged

rustdoc: add option to calculate "documentation coverage" #58626

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
009c91a
add option to calculate documentation coverage
QuietMisdreavus Jan 30, 2019
9e98a25
tabs -> spaces
QuietMisdreavus Jan 30, 2019
fc94593
count fewer items in calculate-doc-coverage
QuietMisdreavus Feb 20, 2019
95500c0
refactor: combine item count numbers into a new struct
QuietMisdreavus Feb 20, 2019
5eb1ab5
print doc coverage as a table of individual item types
QuietMisdreavus Feb 21, 2019
a3a2559
add a coverage mode for private items
QuietMisdreavus Feb 21, 2019
3ce19b4
tweak wording of extern types
QuietMisdreavus Feb 21, 2019
63bdd29
add tests for doc coverage
QuietMisdreavus Feb 21, 2019
80b4919
update docs for doc coverage
QuietMisdreavus Feb 21, 2019
1b63543
track items per-file instead of per-type
QuietMisdreavus Feb 28, 2019
74cf1ad
tweak docs for rustdoc's `--show-coverage`
QuietMisdreavus Feb 28, 2019
515dbe7
update rustdoc coverage tests with new table layout
QuietMisdreavus Feb 28, 2019
e28cf74
remove unused Display impl
QuietMisdreavus Mar 5, 2019
3df0b89
only print coverage pass lists if running on nightly
QuietMisdreavus Mar 5, 2019
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
Prev Previous commit
Next Next commit
count fewer items in calculate-doc-coverage
  • Loading branch information
@QuietMisdreavus
QuietMisdreavus committed Feb 28, 2019
commit fc9459351c0136715089f9e9d96f57fed2c80a52
6 changes: 5 additions & 1 deletion src/librustdoc/passes/calculate_doc_coverage.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,11 @@ struct CoverageCalculator {
impl fold::DocFolder for CoverageCalculator {
fn fold_item(&mut self, i: clean::Item) -> Option<clean::Item> {
match i.inner {
clean::StrippedItem(..) => {}
clean::StrippedItem(..) => {
// don't count items in stripped modules
return Some(i);
}
clean::ImportItem(..) | clean::ExternCrateItem(..) => {}
clean::ImplItem(ref impl_)
if attr::contains_name(&i.attrs.other_attrs, "automatically_derived")
|| impl_.synthetic || impl_.blanket_impl.is_some() =>
Expand Down