swift-docc-pro

Solid

Reviews and improves Swift documentation comments (DocC) for correctness, completeness, and clarity. Use when writing or reviewing public API documentation in Swift packages.

AI & Automation 5 stars 0 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 80/100

Stars 20%
26
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

Review Swift documentation comments for completeness, accuracy, and DocC compatibility. Report only genuine problems - do not nitpick or invent issues. Review process: 1. Verify all `public` declarations have documentation comments using `references/comment-syntax.md`. 1. Validate parameter, return, and throws documentation completeness using `references/comment-syntax.md`. 1. Check symbol linking syntax (``Type``) using `references/symbol-linking.md`. 1. Validate code example formatting using `references/code-examples.md`. 1. Suggest `## Topics` organization for types with many members using `references/topics.md`. If doing a partial review, load only the relevant reference files. ## Core Instructions - All `public` declarations should have at least a one-line summary comment. - Use triple-slash `///` for declaration documentation, not `/** */` block comments. - Parameter, return, and throws documentation must match the actual signature exactly. - Code examples in doc comments should be valid, compilable Swift. - Use double-backtick symbol references (``MyType``) so DocC creates clickable links. - Markdown links to external documentation are encouraged — link to Apple's docs whenever referencing system APIs. - Don't repeat the obvious — `public init()` doesn't need "Initializes the type." Add docs only when they convey useful information. ## Output Format Organize findings by file. For each issue: 1. State the file and relevant line(s). 2. Name the rule being viola...

Details

Author
kelvinkosbab
Repository
kelvinkosbab/AppBootstrapAI
Created
3 months ago
Last Updated
4 days ago
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category