Kotlin/dokka
Dokka
Dokka is an extensible documentation engine designed to generate structured API reference materials for Kotlin projects. By parsing source code and comments, it functions as a static site generator that transforms codebases into readable documentation. It integrates directly into development workflows as a build system plugin, allowing for the automated creation of reference materials during the standard compilation process.
The project distinguishes itself through a modular, plugin-driven processing pipeline that allows developers to modify the generation workflow, customize output formats, and adjust visual styling. It supports complex project structures by aggregating documentation from multiple subprojects into a single, unified output. Furthermore, it includes a cross-reference engine that resolves internal code symbols and links to external library documentation, ensuring that generated materials remain connected and navigable.
The engine provides extensive control over the final output, including the ability to filter specific code elements, embed live usage examples, and link directly to remote source code repositories. It supports multiple output formats, such as HTML, Markdown, and Javadoc, and allows for deep customization of templates and assets to meet specific branding or documentation requirements. The tool is designed to be invoked via command-line interfaces or through native build tool integrations, facilitating its use in automated deployment pipelines.
Features
- Static Documentation Generators - Generates static HTML websites from source code and comments for API reference hosting.
- API Documentation Generators - Parses source code and comments to produce structured reference documentation in standard formats.
- API Documentation Generators - Parses Kotlin source code and comments to produce structured, professional reference documentation in multiple formats.
- Documentation Engines - Acts as a specialized engine for parsing Kotlin source code and comments into structured API reference materials.
- Build Plugin Integrations - Functions as a native build system plugin to automate documentation generation within standard development workflows.
- Source Code Documentation Tools - Extracts structured documentation from source code comments using specialized tags.
- Build Tool Integrations - Integrates directly into build lifecycles to automate documentation generation during the standard compilation process.
- Build Tool Integrations - Integrates directly into build systems to automate the generation of API reference materials during the compilation process.
- Document Formatting Frameworks - Provides a modular, extensible framework that supports custom plugins for modifying generation pipelines and output formats.
- Multi-Document Project Builders - Combines documentation from multiple subprojects into a single unified output for complex codebases.
- Plugin Development Frameworks - Supports a modular, plugin-driven pipeline that allows developers to build custom extensions for modifying the generation workflow.
- External Documentation Links - Links API types to external documentation to provide complete context for external code dependencies.
- Markdown Documentation - Generates API reference documentation in Markdown format for easy integration into repositories.
- Static Site Generators - Transforms source code and documentation files into a static website for hosting API reference materials.
- Intermediate Representations - Normalizes diverse source code structures into a unified model to facilitate consistent documentation output.
- CLI Documentation Generation - Provides a command-line interface to trigger documentation generation from source code for automated workflows.
- Dependency Reference Linking - Resolves and links external library dependencies to their hosted documentation for seamless cross-library navigation.
- Multi-Module API Documenters - Aggregates documentation from multiple subprojects into a single unified reference for complex codebases.
- Source Code Linking - Adds direct links from API signatures to remote source code repositories with support for line-number references.
- Documentation Usage Examples - Embeds live, verifiable code samples from existing functions directly into documentation.
- Compiler Frontend Integrations - Parses source code and metadata into an intermediate representation to enable language-agnostic documentation generation.
- Javadoc Generation - Produces standard Javadoc-style HTML documentation by interpreting source code signatures.
- Mixed-Language Project Support - Supports documentation generation for polyglot projects by interpreting comment styles across multiple programming languages.
- Code Definition Linking - Creates cross-references between code elements using bracketed syntax for navigable documentation.
- Documentation Reference Resolution - Maps internal and external code symbols to their respective documentation locations to enable seamless navigation.
- Documentation Logic Extenders - Enables integration of custom plugins to modify the generation process and add specialized documentation features.
- Generator Extension Plugins - Allows enhancing the generation process by integrating custom plugins into the build pipeline.
- Document Processing Pipelines - Executes a modular, plugin-driven processing pipeline that allows developers to extend or modify the documentation generation workflow.
- Documentation Format Plugins - Supports multiple output formats like HTML or Markdown by loading specific plugins into the execution classpath.
- Conversion Output Template Customizers - Separates the documentation data model from the visual presentation layer to allow for flexible customization of generated file formats.
- Documentation Templates - Provides mechanisms to override default page templates for customizing the structure and branding of generated documentation.
