Available on crate feature
doc-audit only.Expand description
Documentation audit system.
Validates ADK-Rust documentation against actual crate implementations:
AuditOrchestrator- Main audit coordinatorDocumentationParser- Parse markdown filesCodeAnalyzer- Analyze Rust source codeExampleValidator- Validate code examplesReportGenerator- Generate audit reports
Available with feature: doc-audit
Modules§
- analyzer
- Code analyzer for extracting API information from Rust codebase.
- cli
- config
- error
- orchestrator
- Audit orchestrator that coordinates all validation components.
- parser
- Documentation parser for extracting and analyzing markdown content.
- reporter
- Report generation functionality for documentation audits.
- suggestion
- Automated fix suggestion engine for documentation audit issues.
- validator
- Example validator for testing code compilation and async patterns.
- version
- Version consistency validation for documentation audit.
Structs§
- ApiReference
- Represents an API reference found in documentation.
- Async
Validation Config - Configuration for async pattern validation.
- Audit
Cli - Documentation audit system for ADK-Rust.
- Audit
Config - Configuration for the documentation audit system.
- Audit
Config Builder - Builder for creating AuditConfig instances.
- Audit
Issue - A specific issue found during documentation audit.
- Audit
Orchestrator - Main orchestrator that coordinates the audit process.
- Audit
Report - Comprehensive audit report containing all findings and statistics.
- Audit
Report Config - Configuration for audit reporting.
- Audit
Summary - High-level statistics and summary of audit results.
- Code
Analyzer - Code analyzer for extracting API information from Rust workspace.
- Code
Example - Represents a code example extracted from documentation.
- Compilation
Error - Represents a compilation error with detailed information.
- Crate
Info - Information about a single crate in the workspace.
- Crate
Registry - Registry of all crates in the workspace with their public APIs.
- Dependency
- Information about a dependency.
- Documentation
Parser - Parser for documentation files that extracts validation-relevant content.
- Example
Validation Result - Result of validating a code example.
- Example
Validator - Validator for code examples that tests compilation and patterns.
- Feature
Mention - Represents a feature flag mention in documentation.
- File
Audit Result - Audit results for a specific file.
- Internal
Link - Represents an internal link to another documentation file.
- Parsed
Document - Represents a parsed documentation file with extracted content.
- Problematic
File - Information about a file with many issues.
- Public
Api - Information about a public API item.
- Recommendation
- Actionable recommendation for improving documentation.
- Report
Generator - Report generator that can output audit reports in multiple formats.
- Suggestion
- Represents an automated fix suggestion.
- Suggestion
Config - Configuration for suggestion generation.
- Suggestion
Engine - Engine for generating automated fix suggestions.
- Validation
Metadata - Additional metadata about the validation process.
- Validation
Result - Result of validating an API reference.
- Version
Reference - Represents a version reference found in documentation.
- Version
Validation Config - Configuration for version validation behavior.
- Version
Validation Result - Result of version validation for a single reference.
- Version
Validator - Version validator that checks consistency between documentation and workspace.
- Workspace
Version Info - Comprehensive workspace version information.
Enums§
- ApiItem
Type - Types of API items that can be referenced in documentation.
- Audit
Command - Available audit commands.
- Audit
Error - Comprehensive error types for the documentation audit system.
- CliOutput
Format - CLI-compatible output format enum.
- CliSeverity
- CLI-compatible severity enum.
- Dependency
Spec - Cargo.toml dependency specification.
- Error
Type - Types of compilation errors that can occur.
- Issue
Category - Categories of issues that can be found during audit.
- Issue
Severity - Severity levels for audit issues.
- Output
Format - Output formats for audit reports.
- Recommendation
Type - Types of recommendations that can be made.
- Suggestion
Type - Types of automated suggestions that can be generated.
- Validation
Severity - Severity levels for version validation issues.
- Version
Tolerance - Tolerance levels for version differences.
- Version
Type - Types of version references that can appear in documentation.
Constants§
- CRATE_
NAME - Name of the crate.
- VERSION
- Version information for the crate.
Type Aliases§
- Result
- Result type for the documentation audit system.