realm/jazzy
Jazzy
Jazzy is a source code documentation tool and API generator designed for Swift and Objective-C. It analyzes project roots and compiled modules to produce searchable HTML websites or offline docsets.
The system functions as a multi-module API documenter, aggregating documentation from separate source modules into a single site with cross-module linking. It serves as a markdown-based documentation engine that integrates technical guides and LaTeX mathematical equations to complement generated API references.
The tool covers a broad capability surface including multi-language API generation for mixed Swift and Objective-C projects, documentation coverage tracking, and XML-based exports for the Dash documentation browser. It supports visual theming, symbol filtering, and the integration of source code links with precise line-range references.
Features
- Swift API Documentation - Generates searchable websites and technical references from Swift and Objective-C source code.
- Documentation Generators - Provides a system that generates technical documentation by extracting and formatting information from source code.
- Project Documentation - Creates a unified documentation site providing technical guidance and API references for mixed-language projects.
- Markdown Documentation - Implements a rendering engine that converts markdown files into technical guides with LaTeX and custom themes.
- Multi-Source Content Aggregation - Merges technical API data from disparate source modules into a unified structure with shared search.
- Compiled Module Analysis - Generates API documentation from compiled module files or frameworks using symbol graphs for faster processing.
- Cross-Module Documentation Unification - Unifies documentation for projects split across separate source modules into a single site with cross-module linking.
- Multi-Module API Documenters - Aggregates documentation from several separate source modules into a single site with cross-module linking.
- Source Code Documentation Tools - Analyzes project roots and compiled modules to automate the creation of technical API references.
- Cross-Module Symbol Linking - Maps declarations across multiple source modules to create a unified search index and hyperlinked reference site.
- Multi-Language API Documentation - Produces searchable websites and docsets from mixed Swift and Objective-C source code.
- Documentation Generators - Processes Objective-C header files using compiler flags and SDK specifications to extract API documentation.
- Documentation Coverage Analysis - Tracks the percentage of documented symbols to analyze documentation gaps and generate coverage badges.
- API Reference Generators - Transforms machine-readable API definitions into formatted technical reference manuals and Dash-compatible docsets.
- Static Documentation Export - Exports API definitions into standalone static files and XML feeds for offline browsing in Dash.
- Markdown Tools - Embeds custom markdown files as standalone guides with support for autolinks, callouts, and footnotes.
- Docset Export Formats - Serializes extracted API data into XML feeds for offline browsing within the Dash documentation browser.
- Docset Generators - Produces XML feeds and docsets for offline browsing within the Dash documentation browser.
- Documentation Build Pipelines - Provides a build pipeline that uses JSON or YAML configuration files to control the documentation generation process.
- Source Code Linking - Links documentation to source code hosted on external git platforms with precise line-range references.
- Integration Guides - Includes external markdown files as dedicated guide pages integrated directly into the navigation sidebar.
- Technical Guides - Integrates structured technical guides and LaTeX mathematical equations to complement generated API references.
- Symbol Graph Analysis - Extracts API metadata from compiled module files to accelerate the documentation generation process.
- Command Line Utilities - Generate documentation for Swift and Objective-C code.
- Developer Utilities And Workflow - Generate documentation for Swift and Objective-C projects.
- Documentation Tools - Documentation generator for Swift and Objective-C.
- Xcode Plugins - Generates documentation from code comments.
