kdoc-migrate

You can automate KDoc generation by orchestrating pattern analysis and validation across your project module by module. This process utilizes pattern documents for contract context to generate consistent KDoc for undocumented public Kotlin APIs, significantly reducing manual effort.

Yes, you can prioritize KDoc migration for interfaces and sealed classes using built-in customization options. This allows you to target specific API structures first, ensuring that the most critical architectural contracts are documented before moving on to the rest of the codebase.

Pattern-driven documentation for Kotlin APIs informs the generated KDoc by using existing pattern documents as context. This approach ensures that the newly generated documentation accurately reflects the intended architectural contracts and behaviors of the API, rather than just describing the syntax.

To run a dry-run for full-project KDoc migration, you execute the migration command with the dry-run option enabled. This allows you to analyze and preview the proposed KDoc additions and validation results across all undocumented public APIs without actually modifying your source code.

Yes, Kotlin KDoc migration operates without requiring external dependencies. The migration process relies entirely on internal scripts and reference components to analyze code patterns, generate KDoc text, and validate the documentation output within your existing project environment.