Skip to content

Add doc comments for all public API and catalog Player/Party#20

Merged
gwillish merged 1 commit intomainfrom
doc-coverage
Apr 4, 2026
Merged

Add doc comments for all public API and catalog Player/Party#20
gwillish merged 1 commit intomainfrom
doc-coverage

Conversation

@gwillish
Copy link
Copy Markdown
Owner

@gwillish gwillish commented Apr 4, 2026

Summary

Documentation pass across the full public API surface:

  • DaggerheartModels.docc/DaggerheartModels.md — adds a Players and Parties topic group with Player and Party so they appear in the generated DocC catalog
  • Player.swift — property docs for all 8 stat fields; init with full Parameters block
  • Party.swiftid and name property docs; init with Parameters block
  • AdversaryState.swiftid, maxHP, maxStress, currentHP, currentStress, isDefeated, conditions docs; init with full Parameters block
  • PlayerState.swiftid, name, maxHP, currentHP, maxStress, currentStress, conditions docs; init with full Parameters block
  • EnvironmentState.swiftid doc; init with Parameters block
  • EncounterSession.swiftid, name, gmNotes docs; init summary; incrementFear, spendFear, incrementHope, spendHope docs
  • Compendium.swiftfileNotFound and decodingFailed case docs
  • SessionRegistry.swiftsessions property doc; init summary
  • EncounterStore.swiftnotFound, saveFailed, deleteFailed case docs; init with Parameters block

No functional changes — doc comments only.

Test plan

  • swift build passes (all targets)
  • swift test — 162 tests pass
  • ./Scripts/format.sh exits clean
  • Linux CI passes

@gwillish gwillish merged commit 0a19d5d into main Apr 4, 2026
2 checks passed
@gwillish gwillish deleted the doc-coverage branch April 4, 2026 20:10
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