apply-docs-swift

Apply YAML documentation to Swift source comments as DocC-compatible comments.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/transistorsoft/docforge --skill apply-docs-swift
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: apply-docs-swift
Source: https://github.com/transistorsoft/docforge/tree/main/skills/apply-docs-swift
Command: npx skills add https://github.com/transistorsoft/docforge --skill apply-docs-swift

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually updating Swift doc comments across the iOS SDK is error-prone and time-consuming. This Skill automates applying harvested YAML documentation to Swift source files to keep inline docs consistent with the docs database.

Core Features & Use Cases

  • Read documentation from the YAML docs database (docs-db/*.yaml) and map entries to Swift declarations in the iOS SDK.
  • Overwrite existing Swift doc comments with generated DocC-compatible comments, including parameter explanations and code examples when available.
  • Support end-to-end doc application for the iOS Swift sources under TSLocationManager/SwiftInterface and related modules.

Quick Start

Run the tool against a glob of YAML docs to apply to the Swift source.

Frequently Asked Questions about apply-docs-swift

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

FAQPage Schema
How do I apply YAML documentation to Swift code comments automatically?

To apply YAML documentation to Swift code comments, use a tool that reads YAML from the docs database, resolves doc-id mappings to Swift declarations, and replaces existing Swift doc comments with generated DocC-compatible comments.

How do I keep iOS SDK doc comments in sync with a docs database?

Keeping iOS SDK doc comments in sync with a docs database involves reading harvested YAML documentation and overwriting existing Swift source comments with generated DocC-compatible comments, including parameter explanations and code examples.

Can I generate DocC-compatible comments for the TSLocationManager SwiftInterface?

Yes, you can generate DocC-compatible comments for the TSLocationManager SwiftInterface by applying harvested YAML documentation that maps entries to Swift declarations across the iOS SDK and related modules.

What's the best way to update Swift doc comments across an iOS SDK?

The best way to update Swift doc comments across an iOS SDK is to automate the process by applying harvested YAML documentation to Swift source files, which avoids the errors and time required for manual updates.

Does this approach support overwriting existing Swift doc comments with code examples?

Yes, applying YAML documentation supports overwriting existing Swift doc comments with generated DocC-compatible comments, including available parameter explanations and code examples when provided in the docs database.