Skip to content

docs: document Switch constructor - #750

Merged
ar merged 1 commit into
mainfrom
docs/switch-constructor-javadoc
Aug 11, 2026
Merged

docs: document Switch constructor#750
ar merged 1 commit into
mainfrom
docs/switch-constructor-javadoc

Conversation

@ar-agt

@ar-agt ar-agt commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Moves the existing selector-construction Javadoc from the configuration field to the Switch constructor, making the Javadoc task warning-free.

private boolean prefixMode;
private List<String> sortedRoutingKeys = List.of(); // kept sorted from longest to shortest

/** Creates the selector; configuration is supplied via {@link #setConfiguration(Configuration)}. */

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The javadoc is for the cfg field. I guess the warning is because the field is Private. I think it could just be removed and document the setConfiguration method instead, or just make it a regular Java line comment.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@alcarraz can you correct this PR ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actually, I misread the javadoc, sorry for the noise, this is OK, looking up the history this was the original javadoc for the constructor, that was left misplaced by #749.

I will still take the chance to write the javadoc for setConfiguration since I'm here.

@ar
ar merged commit ed37c31 into main Aug 11, 2026
1 check passed
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