TMDb: Skill for Claude Code

Document Swift (DocC conventions)

The canonical guide for documenting public API in the TMDb Swift package. Apply these conventions inline, in the same step you write the declaration — a public symbol without a /// comment is not finished (CLAUDE.md requires it, and make build-docs runs warnings-as-errors, so a miss breaks the build). For documenting many files at once, the documentation-writer agent follows these same rules in an isolated context.

Scope

• Document only public declarations — skip internal, private, fileprivate, package.
• Document every public declaration — no "self-explanatory" exceptions: protocols, classes, structs, enums (and cases where meaning isn't obvious), actors, typealiases, models, stored/computed properties, initializers, methods, subscripts. Custom init(from:) / encode(to:) in a public extension need comments too (a common miss).
• Use /// style — never /** */.
• 100-character line length; wrap continuation lines indented to align with the text above.

Summary patterns

The first /// line after the opening blank /// is the summary. Match the project's house style by declaration kind:

• Method — verb phrase: "Returns the primary information about a movie." (not "Gets a movie.")
• Property — noun phrase: "Movie identifier." (not "The ID of the movie.")
• Type (struct/class) — "A model representing a [noun]."
• Protocol — "Provides an interface for [verb]-ing [noun] from TMDb."
• Enum — "A model representing a [noun]."; cases use concise noun phrases/adjectives.
• Initializer — "Creates a [type description] object."

Be concise. Extra detail goes in later paragraphs only when it adds something the signature doesn't.

Structure of a doc comment

Opening ///, summary, blank ///, then sections in this order, each separated by a blank /// line: API link → Precondition → Parameters → Throws → Returns. No trailing whitespace on blank /// lines.