Skip to content
This repository has been archived by the owner on Aug 30, 2023. It is now read-only.

added a few java docs (Sentry, Hub and SentryClient) #223

Merged
merged 3 commits into from
Jan 15, 2020

Conversation

marandaneto
Copy link
Contributor

📢 Type of change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring

📜 Description

added a few java docs.

💡 Motivation and Context

we are poor of javadocs.

💚 How did you test it?

📝 Checklist

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

🔮 Next steps

more and more javadocs

Copy link
Contributor Author

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

@bruno-garcia do we need to javadocs the Impl. classes or only the public interfaces?

@bruno-garcia
Copy link
Member

@marandaneto Ideally all public types their members.

I'd say at least all public API from Sentry, SentryOptions, SentryClient, Hub, SentryEvent and Scope. Anything else major you'd suggest?

Copy link
Member

@bruno-garcia bruno-garcia left a comment

Choose a reason for hiding this comment

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

👍
CI is unhappy somehow

@marandaneto marandaneto requested a review from HazAT January 14, 2020 22:23
@marandaneto
Copy link
Contributor Author

CI is unhappy somehow

because of #224 already fixed it

@codecov-io
Copy link

codecov-io commented Jan 14, 2020

Codecov Report

❗ No coverage uploaded for pull request base (master@6770616). Click here to learn what that means.
The diff coverage is 0%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #223   +/-   ##
=========================================
  Coverage          ?   58.17%           
  Complexity        ?      570           
=========================================
  Files             ?       72           
  Lines             ?     2697           
  Branches          ?      238           
=========================================
  Hits              ?     1569           
  Misses            ?     1014           
  Partials          ?      114
Impacted Files Coverage Δ Complexity Δ
...ntry-core/src/main/java/io/sentry/core/Sentry.java 0% <0%> (ø) 0 <0> (?)

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 6770616...e168472. Read the comment docs.

@marandaneto marandaneto merged commit be6f131 into master Jan 15, 2020
@marandaneto marandaneto deleted the javadocs/sentry_hub_client branch January 15, 2020 08:47
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants