documentation_coverage

Notedocblock 
documentation_coverage(module_name::Module; exported_only::Bool=true) -> NamedTuple

Calculate documentation coverage statistics for a module.

Arguments

  • module_name::Module: Module to analyze
  • exported_only::Bool: Only consider exported symbols (default: true)

Returns

NamedTuple with fields:

  • total::Int: Total number of symbols
  • documented::Int: Number of documented symbols
  • missing::Int: Number of undocumented symbols
  • coverage::Float64: Coverage percentage (0-100)
  • missing_symbols::Vector{Symbol}: List of undocumented symbols

Example

stats = documentation_coverage(MyModule)
println("Documentation coverage: $(stats.coverage)%")
println("Missing: $(stats.missing_symbols)")