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

Make sure Spring components can be clearly identified in the Javadoc #221

Closed
odrotbohm opened this issue Nov 22, 2018 · 0 comments
Closed
Assignees
Milestone

Comments

@odrotbohm
Copy link
Member

There seems to be a bit of confusion which of the interfaces in Salespoint describe consumable components and which of them are provided as Spring beans by default. This probably stems from the fact that most implementations are package private and thus – rightfully so – aren't even listed.

We should make this clear in the Javadoc, probably by also annotating the service interfaces with @Service.

@odrotbohm odrotbohm added this to the 7.2 milestone Sep 26, 2019
@odrotbohm odrotbohm self-assigned this Sep 27, 2019
odrotbohm added a commit that referenced this issue Sep 27, 2019
…otations.

As our implementation classes are package protected to avoid client code to refer to them, they don't appear in Salespoint's Javadoc. That makes it hard to identify which of the types are actually candidates for injection into student project's code.

We now explicitly annotate the public interfaces of those components with the Spring stereotype annotations although that sometimes wouldn't even be necessary (e.g. in the case of Spring Data repositories).
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

No branches or pull requests

1 participant