Add java doc based on sentry-data-schemes project

[Panthaaaa]

📢 Type of change

• Bugfix
• New feature
• Enhancement
• Refactoring

📜 Description

Added java docs to the protocol classes based on the https://github.com/getsentry/sentry-data-schemas project.

💡 Motivation and Context

It improves accessibility of the SDK because all the important information is directly in the javadoc instead of in someones browser.

💚 How did you test it?

make compile as I only added java docs.

📝 Checklist

• I reviewed submitted code
• I added tests to verify changes
• All tests passing
• No breaking changes

🔮 Next steps

[marandaneto]

thanks for doing this @Panthaaaa appreciated.

I've written 2 or 3 comments but they are easy fixes, work on them and LGTM.

[marandaneto]

./gradlew spotlessApply would fix the broken CI :)

[maciejwalkowiak]

This is awesome! Thanks a lot for this PR.

[Panthaaaa]

./gradlew spotlessApply would fix the broken CI :)

It fixed it, but its conflicting with the editorconfig. (So IDEA reverted it on commit, but I think thats why you recommend the commit-hook)

[codecov-io]

Codecov Report

Merging #1045 (0974217) into main (e0aad49) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##               main    #1045   +/-   ##
=========================================
  Coverage     71.98%   71.98%           
  Complexity     1322     1322           
=========================================
  Files           135      135           
  Lines          4816     4816           
  Branches        492      492           
=========================================
  Hits           3467     3467           
  Misses         1091     1091           
  Partials        258      258           

Impacted Files	Coverage Δ	Complexity Δ
sentry/src/main/java/io/sentry/protocol/App.java	96.55% <ø> (ø)	18.00 <0.00> (ø)
...ntry/src/main/java/io/sentry/protocol/Browser.java	100.00% <ø> (ø)	8.00 <0.00> (ø)
...y/src/main/java/io/sentry/protocol/DebugImage.java	3.33% <ø> (ø)	1.00 <0.00> (ø)
...ry/src/main/java/io/sentry/protocol/DebugMeta.java	11.11% <ø> (ø)	1.00 <0.00> (ø)
sentry/src/main/java/io/sentry/protocol/Gpu.java	100.00% <ø> (ø)	22.00 <0.00> (ø)
...ry/src/main/java/io/sentry/protocol/Mechanism.java	37.93% <ø> (ø)	6.00 <0.00> (ø)
...ntry/src/main/java/io/sentry/protocol/Message.java	33.33% <ø> (ø)	3.00 <0.00> (ø)
.../main/java/io/sentry/protocol/OperatingSystem.java	100.00% <ø> (ø)	16.00 <0.00> (ø)
...ntry/src/main/java/io/sentry/protocol/Request.java	14.81% <ø> (ø)	3.00 <0.00> (ø)
...ntry/src/main/java/io/sentry/protocol/SdkInfo.java	0.00% <ø> (ø)	0.00 <0.00> (ø)
... and 10 more

---

Continue to review full report at Codecov.

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