docs: call out beta status for all public-facing profiling APIs

[armcknight]

Add notes and beta warnings to all public-facing APIs for profiling.

#skip-changelog

[github-actions]

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1230.53 ms	1239.44 ms	8.91 ms
Size	20.76 KiB	425.81 KiB	405.04 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
28333b6	1247.29 ms	1262.51 ms	15.22 ms
561fa74	1243.27 ms	1260.62 ms	17.35 ms
8f397a7	1236.76 ms	1256.76 ms	20.00 ms
d10ae0c	1250.02 ms	1253.74 ms	3.72 ms
7bc3c0d	1222.86 ms	1244.90 ms	22.04 ms
ad7cec6	1203.22 ms	1224.74 ms	21.52 ms
7fb7afb	1235.00 ms	1256.81 ms	21.81 ms
78d5983	1229.98 ms	1245.60 ms	15.62 ms
443723a	1205.24 ms	1220.52 ms	15.28 ms
eaa1002	1205.50 ms	1235.08 ms	29.58 ms

App size

Revision	Plain	With Sentry	Diff
28333b6	20.76 KiB	424.69 KiB	403.93 KiB
561fa74	20.76 KiB	427.23 KiB	406.46 KiB
8f397a7	20.76 KiB	420.55 KiB	399.79 KiB
d10ae0c	20.76 KiB	419.86 KiB	399.10 KiB
7bc3c0d	20.76 KiB	427.36 KiB	406.59 KiB
ad7cec6	20.76 KiB	427.32 KiB	406.55 KiB
7fb7afb	20.76 KiB	419.69 KiB	398.94 KiB
78d5983	20.76 KiB	427.80 KiB	407.04 KiB
443723a	20.76 KiB	414.44 KiB	393.68 KiB
eaa1002	20.76 KiB	423.19 KiB	402.43 KiB

Previous results on branch: armcknight/docs/profiling-beta-callout-headerdocs

Startup times

Revision	Plain	With Sentry	Diff
1dea7d5	1242.48 ms	1256.17 ms	13.69 ms

App size

Revision	Plain	With Sentry	Diff
1dea7d5	20.76 KiB	427.35 KiB	406.59 KiB

[codecov]

Codecov Report

Merging #2804 (ccf9ea3) into main (e20c660) will increase coverage by 1.53%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2804      +/-   ##
==========================================
+ Coverage   79.78%   81.31%   +1.53%     
==========================================
  Files         258      258              
  Lines       24267    24139     -128     
  Branches    10451    10713     +262     
==========================================
+ Hits        19361    19629     +268     
+ Misses       4398     4012     -386     
+ Partials      508      498      -10     

see 50 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 e20c660...ccf9ea3. Read the comment docs.

[philipphofmann]

Excellent 💯. For experimental features we have something similar, see

sentry-cocoa/Sources/Sentry/Public/SentryOptions.h

Lines 162 to 170 in 06548c0

	/**
	* Attention: This is an experimental feature. Turning this feature on can have an impact on
	* the grouping of your issues.
	*
	* When enabled, the SDK stitches stack traces of asynchronous code together.
	*
	* This feature is disabled by default.
	*/
	@property (nonatomic, assign) BOOL stitchAsyncCode;

Do you mind aligning how we point out beta and experimental?

[armcknight]

Do you mind aligning how we point out beta and experimental?

@philipphofmann I don't mind, but I'm not sure what you have in mind. Do you want ours to match yours, or vice-versa?

[philipphofmann]

Do you mind aligning how we point out beta and experimental?

@philipphofmann I don't mind, but I'm not sure what you have in mind. Do you want ours to match yours, or vice-versa?

I don't really mind which one, as long as it's consistent. We can also keep it as it is. Most important that we inform the users about experimental and beta features. I think for the experimental features it's important to mention that they are experimental at the beginning of the code docs.

[armcknight]

@philipphofmann I turned every note about beta/experimental features into @warning in objc and - warning: in swift headerdocs, at the beginning of whatever comment block it lives in.

[philipphofmann]

Thanks @armcknight 💯