Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add java doc based on sentry-data-schemes project #1045

Merged
merged 6 commits into from
Nov 16, 2020

Conversation

Panthaaaa
Copy link
Contributor

@Panthaaaa Panthaaaa commented Nov 13, 2020

📢 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

Copy link
Contributor

@marandaneto marandaneto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for doing this @Panthaaaa appreciated.

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

Lukas Mader and others added 2 commits November 16, 2020 09:07
Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com>
@marandaneto
Copy link
Contributor

./gradlew spotlessApply would fix the broken CI :)

Copy link
Contributor

@maciejwalkowiak maciejwalkowiak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome! Thanks a lot for this PR.

@Panthaaaa
Copy link
Contributor Author

./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
Copy link

Codecov Report

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

Impacted file tree graph

@@            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.

@marandaneto marandaneto merged commit bcbd5c5 into getsentry:main Nov 16, 2020
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.

4 participants