Skip to content

Add @Documented where it's currently missing#86

Merged
amaembo merged 1 commit intoJetBrains:masterfrom
Thijsiez:master
Feb 17, 2023
Merged

Add @Documented where it's currently missing#86
amaembo merged 1 commit intoJetBrains:masterfrom
Thijsiez:master

Conversation

@Thijsiez
Copy link
Contributor

While writing a library, I found that @Language annotations and the resulting code highlighting in IntelliJ did not show up in projects implementing the library. I reckoned that adding @Documented where it was currently missing would improve the overall usability of the annotations in this project.
I chose to only increase the patch version and not the minor version as this change is really just a (generated) javadoc change.

@amaembo
Copy link
Collaborator

amaembo commented Feb 17, 2023

Thanks. @Subst looks too technical thing and probably is not necessary to be mentioned in the documentation. Probably @Flow as well.

@chashnikov what do you think about this change?

@chashnikov
Copy link
Member

I agree, it makes sense to add @Documented to some annotations. I would skip it for @Subst, @Flow indeed, as they are mostly for tools, not for humans.

@Thijsiez
Copy link
Contributor Author

I've undone the changes for @Flow and @Subst, thanks for the feedback!

@amaembo amaembo merged commit 0d08bfd into JetBrains:master Feb 17, 2023
@amaembo
Copy link
Collaborator

amaembo commented Feb 17, 2023

Merged, thanks!

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.

3 participants