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

User Guide: Type-use annotation syntax for full qualified names #453

Open
bjmi opened this issue Jan 12, 2024 · 1 comment
Open

User Guide: Type-use annotation syntax for full qualified names #453

bjmi opened this issue Jan 12, 2024 · 1 comment
Labels
documentation For issues related to user-facing documentation nullness For issues specific to nullness analysis.

Comments

@bjmi
Copy link

bjmi commented Jan 12, 2024

This is a follow up of https://groups.google.com/g/jspecify-discuss/c/eCiRwkUC52k/m/K8YHKkUcAgAJ

https://jspecify.dev/docs/user-guide#type-use-annotation-syntax mentions type use syntax for nested static type and array type.

Sometimes it is necessary to write the full qualified name of a type e.g. because of name clash thus the syntax is
java.lang.@Nullable String instead of @Nullable java.lang.String

A full qualified name example could help jspecify adopters that aren't familiar with type use annotation syntax.

Hence, please add a short example for this use case.

@kevinb9n
Copy link
Collaborator

In fact another easy way this can happen is if using Map.Entry and Multiset.Entry in the same file.

In general, we may have documented a number of things as though the reader knows all about annotations already. But the more JSpecify were to be embraced the more that it might be how a user is introduced to annotations.

@kevinb9n kevinb9n added the documentation For issues related to user-facing documentation label Jan 31, 2024
@kevinb9n kevinb9n added the nullness For issues specific to nullness analysis. label Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation For issues related to user-facing documentation nullness For issues specific to nullness analysis.
Projects
None yet
Development

No branches or pull requests

2 participants