search

getsentry / team-mobile

Meta issues for the Mobile team
4 stars 1 forks source link

Revisit public API of the SDK #57

Open romtsn opened 2 years ago

romtsn commented 2 years ago

Go through the experimental/internal annotations or modifiers or comments (whatever is applicable to the platform) and check if they still make sense or should be removed.

For example, some of the classes are marked as @Internal in the java SDK, while they are actually documented and are part of the official protocol. Plus, they are used in the EventProcessor API, so they are effectively public.

We could do this for all SDKs as a general cleanup and revisit:

brustolin commented 2 years ago

What is the desired outcome of this issue? When do we know that we are good? Do we have complains about missing things?

marandaneto commented 2 years ago

Dart has @experimental and @internal annotations. Java has @ApiStatus.* RN not sure, I guess just comments or method docs? we use @deprecated for method docs but not sure about any other.