Skip to content

docs: add Swift doc comments to public APIs#12

Merged
tannn merged 1 commit intomainfrom
docs-backfill/swift-doc-comments
Mar 3, 2026
Merged

docs: add Swift doc comments to public APIs#12
tannn merged 1 commit intomainfrom
docs-backfill/swift-doc-comments

Conversation

@tannn
Copy link
Owner

@tannn tannn commented Mar 2, 2026

Summary

  • Add /// doc comments to all public protocols, actors, classes, structs, enums, methods, and properties across 16 core source files (~5,635 lines of code)
  • Covers Tier 1 (protocols and core services: AIServiceProtocol, ProvocationOrchestrating, TextCaptureServiceProtocol, DiagnosticsLogging, ErrorPresentationMapping) and Tier 2 (supporting infrastructure: AppState, AppContainer, FloatingPanelViewModel, AppSettings, and all model/utility types)
  • Each comment describes purpose, parameters, return values, concurrency constraints (actor isolation, @MainActor), and error conditions
  • No code logic changed — documentation annotations only

Files modified

AIService.swift, ProvocationOrchestrator.swift, DefaultAIService.swift, AppState.swift, AppSettings.swift, FloatingPanelViewModel.swift, AppContainer.swift, FreeThinkerError.swift, DefaultTextCaptureService.swift, ProvocationPromptComposer.swift, ProvocationResponseParser.swift, ProvocationRequest.swift, ProvocationResponse.swift, DiagnosticEvent.swift, ErrorPresentationMapper.swift, DiagnosticsLogger.swift

Test plan

  • Verify Xcode builds cleanly with no new warnings on the changed files
  • Open Quick Help (⌥-click) on public types to confirm documentation renders correctly
  • Run existing test suite to confirm no regressions

🤖 Generated with Claude Code


Automated by nightshift

Add /// doc comments to all public protocols, actors, classes, structs,
enums, methods, and properties across 16 core source files. Comments
describe purpose, parameters, return values, concurrency constraints
(actor isolation, @mainactor), and error conditions. No code logic changed.

Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@tannn tannn merged commit 5ed2557 into main Mar 3, 2026
6 checks passed
@tannn tannn deleted the docs-backfill/swift-doc-comments branch March 3, 2026 06:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant