Skip to content

Enable missing_docs rule and add missing API documentation - #62

Merged
ctreffs merged 2 commits into
masterfrom
missing-docs
Aug 24, 2026
Merged

Enable missing_docs rule and add missing API documentation#62
ctreffs merged 2 commits into
masterfrom
missing-docs

Conversation

@ctreffs

@ctreffs ctreffs commented Aug 24, 2026

Copy link
Copy Markdown
Member

Context & Summary

This PR enables the missing_docs SwiftLint rule in .swiftlint.yml to enforce documentation for public APIs and adds missing documentation comments across FirebladeMath.

What Changed

  • .swiftlint.yml: Enabled the missing_docs rule under opt_in_rules.
  • Sources/FirebladeMath/Quat/Quaternion+Identity.swift: Added SwiftDoc comments for Quat4d.identity and Quat4f.identity.
  • Sources/FirebladeMath/Quat/Quat4f+Euler.swift: Added SwiftDoc comments for Euler conversion functions (fromEulerAngles_*, quaternionToEulerAngles_*), initializer init(pitch:yaw:roll:), and eulerAngles, pitch, yaw, roll accessors.
  • Sources/FirebladeMath/Functions/radians.swift: Added SwiftDoc comments for radians(_ degrees: Vec3f).

Reviewer Guidance

Testing Steps

  1. Run make lint to verify SwiftLint passes without warnings.
  2. Run make test to verify all test suites compile and pass.

Risk of Regression

  • Level: Low
  • Rationale: Changes are strictly additions of SwiftDoc comments and enabling a SwiftLint rule. No operational logic was modified.

Focus Areas

  • Public API documentation coverage in Quat4f+Euler.swift.

@ctreffs
ctreffs enabled auto-merge (squash) August 24, 2026 09:34
@ctreffs
ctreffs merged commit 3a48f8d into master Aug 24, 2026
12 checks passed
@ctreffs
ctreffs deleted the missing-docs branch August 24, 2026 09:38
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