-
Notifications
You must be signed in to change notification settings - Fork 56
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 message value to API-tools annotations #1133
Add message value to API-tools annotations #1133
Conversation
Test Results 290 files ±0 290 suites ±0 59m 13s ⏱️ + 4m 38s For more details on these failures, see this check. Results for commit 03bb60d. ± Comparison against base commit bc22b07. ♻️ This comment has been updated with latest results. |
c06e838
to
667c419
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
@HannesWell just one thing to note as we almost ever have the same "text" maybe the default should not be empty (even though I'm not sure if default text will showup in the javadoc?) |
That's a good suggestion. |
This allows users of the annotations to provide contextual information to clients about why the annotations is applied. This is common for users of the javadoc-annotations, but at the moment not possible when using the java-annotations. Later PDE's API-Tools could also provide that information to developers of clients.
667c419
to
03bb60d
Compare
Added a default value for all annotations based on the texts commonly used throughout the Eclipse SDK. I also checked if default values/messages are displayed in the javadoc and at least the Eclipse built-in Javadoc view does not render the |
This allows users of the annotations to provide contextual information to clients about why the annotations is applied.
This is common for users of the javadoc-annotations, but at the moment not possible when using the java-annotations.
Later PDE's API-Tools could also provide that information to developers of clients.
Instead of
one can use