Skip to content

docs: backfill missing Swift doc comments on public APIs#22

Open
tannn wants to merge 1 commit into
mainfrom
docs/backfill-swift-doc-comments
Open

docs: backfill missing Swift doc comments on public APIs#22
tannn wants to merge 1 commit into
mainfrom
docs/backfill-swift-doc-comments

Conversation

@tannn
Copy link
Copy Markdown
Owner

@tannn tannn commented Apr 10, 2026

Summary

  • Adds type-level and member-level Swift doc comments to seven source files that had gaps in public API documentation
  • No behaviour changes; all edits are additive doc comment only

Files changed

  • FloatingPanelComponents.swift — type-level docs on FloatingPanelDesignTokens, FloatingPanelLoadingView, FloatingPanelResponseCard, FloatingPanelErrorCallout; parameter docs on each public init
  • FloatingPanelView.swift — type-level doc on FloatingPanelView
  • MenuBarCoordinator.swift — class doc, installStatusItemIfNeeded, uninstallStatusItem, callback property docs
  • Logger.swiftLogger enum doc, all Category cases, four static log-level methods
  • FloatingPanelViewModel.swiftsetErrorMessage(_:) and copyText
  • AppState.swift — eleven convenience setter methods
  • DiagnosticEvent.swift — four public static redaction helpers

Test plan

  • Verify Swift build succeeds with no warnings
  • Review doc comments render correctly in Xcode Quick Help

Automated by nightshift

@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

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