Skip to content

Conversation

Emkas
Copy link
Contributor

@Emkas Emkas commented Oct 19, 2021

4 commits that are removing most of javadoc warnings:

  • javadoc: fixed invalid usage of & tag
  • javadoc: fixed various broken links (this change leaves out 2 problems which I have no idea how to solve - ServletBearerExchangeFilterFunction.java:54 and SwitchUserWebFilter.java:83, especially the first one is broken from a very long time and a change that broke this gives me no clue what is the replacement :-))
  • javadoc: @author doesn't work in methods
  • javadoc: fixed invalid usege of > tag

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Oct 19, 2021
@eleftherias eleftherias self-assigned this Oct 21, 2021
@eleftherias eleftherias added in: docs An issue in Documentation or samples type: bug A general bug and removed status: waiting-for-triage An issue we've not yet triaged labels Oct 21, 2021
Copy link
Contributor

@eleftherias eleftherias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Emkas!

I just have two comments about the commit messages.
We don't use the convention of prefixing the messages with javadoc:.
Please use a simple sentence, for example Fix invalid usage of & tag in Javadocs.

Please avoid using the @ character in the message as it may accidentally tag a user.

@Emkas
Copy link
Contributor Author

Emkas commented Oct 21, 2021

No problem, tell me if this is what you wanted.

@Emkas Emkas requested a review from eleftherias October 21, 2021 09:40
@eleftherias eleftherias added this to the 5.6.0 milestone Oct 21, 2021
@eleftherias eleftherias merged commit cb70b6a into spring-projects:main Oct 21, 2021
@eleftherias
Copy link
Contributor

Thanks @Emkas! This is now merged into main.

@Emkas Emkas deleted the javadoc-warns-fix branch October 21, 2021 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in: docs An issue in Documentation or samples type: bug A general bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants