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

Javadocs for @RequestMapping not so useful in 5.0 [SPR-16266] #20813

Closed
spring-issuemaster opened this issue Dec 5, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@spring-issuemaster
Copy link
Collaborator

commented Dec 5, 2017

Dave Syer opened SPR-16266 and commented

I miss the old javadocs for @RequestMapping. I can see why they were changed because the annotation is not specific to servlet MVC any more, but I liked being able to see it in the IDE. Could we backport it to RequestMappingHandlerAdapter or something (and the same for the reactive stack)? There is a link to there in the javadocs for @RequestMapping now, but there isn't much information there really (even less for the reactive one).


Affects: 5.0.2

Referenced from: commits 446e7ed

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator Author

commented Jan 8, 2018

Rossen Stoyanchev commented

It was unwieldy and difficult to maintain this level of detail in the Javadoc, not to mention hard to read. It was also duplicated across the javadoc and reference (the two slightly out of sync over time). The reference is now the single source of truth and it's good this way also because we have links inserting to more details in the reference.

I can insert links from the Javadoc to the reference to make it easy to get there. Here and also here.

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator Author

commented Jan 8, 2018

Dave Syer commented

Links would be fine by me (even better would be some magic by Jay that managed the content in a common place).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.