document-api

Generate Markdown API documentation from Swift source code.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/saxjax/saxjaxTuner --skill document-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-api
Source: https://github.com/saxjax/saxjaxTuner/tree/main/.github/skills/document-api
Command: npx skills add https://github.com/saxjax/saxjaxTuner --skill document-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generates Markdown API documentation for Swift classes and structs. It extracts public and internal API details from DocC-style comments to create developer-focused docs.

Core Features & Use Cases

  • Generates Markdown API docs for public and internal members from Swift source files.
  • Supports properties, initializers, and methods, with summaries derived from DocC-style comments.
  • Use Case: produce comprehensive API references for Swift-based iOS components to share with teams.

Quick Start

Run the tool on a Swift project to generate a Markdown API reference for all public interfaces.

Frequently Asked Questions about document-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Markdown API documentation from Swift source code?

To generate Markdown API documentation from Swift source code, use a tool that parses Swift files to extract public and internal API details from DocC-style comments. It outputs a structured Markdown document listing properties, initializers, and methods for developer reference.

Does Swift API documentation generation work with internal members and DocC comments?

Yes, Swift API documentation generation works with internal members and DocC comments. The parser extracts both public and internal API details from DocC-style comments to produce a comprehensive Markdown reference covering properties, initializers, and methods.

What's the best way to create developer docs for iOS Swift components?

The best way to create developer docs for iOS Swift components is to automatically generate Markdown API references by parsing Swift source files. This extracts structured API details from DocC-style comments, producing a comprehensive document to share with development teams.

Can I extract properties, initializers, and methods from Swift structs into a Markdown file?

Yes, you can extract properties, initializers, and methods from Swift structs into a Markdown file. The parsing process automatically identifies these API members in Swift source code and outputs them in a structured Markdown document suitable for developer documentation.

Do I need DocC-style comments to generate Swift API documentation?

Yes, DocC-style comments are needed to generate Swift API documentation with summaries. The documentation generator parses these comments in your Swift source code to extract API details and derive summaries for properties, initializers, and methods in the output Markdown.

What is automated Swift API documentation generation and when do I need it?

Automated Swift API documentation generation is the process of parsing Swift source code to extract public and internal API details into a structured Markdown document. You need it when producing comprehensive API references for Swift-based iOS components to share with teams.