docs: swiftify the headerdocs

[armcknight]

A suggestion to make the headerdocs idiomatically swift:

• use /// instead of /** */
• use e.g. - parameter paramName: instead of @param paramName
• use backticks where we used to have @c

A couple very small tweaks to improve things, like marking a few more things with - note: and - seealso:

#skip-changelog

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.542%. Comparing base (0f1064f) to head (4f929a3).

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@                     Coverage Diff                     @@
##           convertSentrySDKSwift     #5718       +/-   ##
===========================================================
- Coverage                 86.560%   86.542%   -0.018%     
===========================================================
  Files                        422       421        -1     
  Lines                      36095     36077       -18     
  Branches                   15370     15366        -4     
===========================================================
- Hits                       31244     31222       -22     
- Misses                      4809      4814        +5     
+ Partials                      42        41        -1     

Files with missing lines	Coverage Δ
Sources/Swift/Helper/SentrySDK.swift	85.906% <ø> (ø)

... and 13 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0f1064f...4f929a3. Read the comment docs.

[philipphofmann]

Thanks, @armcknight. It would be great to have some linter for this to ensure it doesn't happen again.