check_missing_docstrings

Notedocblock 
check_missing_docstrings(module_name::Module; exported_only::Bool=true, warn::Bool=true) -> Vector{Symbol}

Check for exported symbols that are missing documentation. Returns a list of undocumented symbols.

Arguments

  • module_name::Module: Module to check
  • exported_only::Bool: Only check exported symbols (default: true)
  • warn::Bool: Print warnings for missing docstrings (default: true)

Returns

Vector of symbols that are missing documentation.

Example

# Check and warn about missing docstrings
missing = check_missing_docstrings(MyModule)

# Check without warnings
missing = check_missing_docstrings(MyModule; warn=false)

# Check all symbols, not just exported
missing = check_missing_docstrings(MyModule; exported_only=false)