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

DOC: javadoc improvements: typos, incorrect links, package-info #1596

Closed
remkop opened this issue Feb 22, 2022 · 0 comments
Closed

DOC: javadoc improvements: typos, incorrect links, package-info #1596

remkop opened this issue Feb 22, 2022 · 0 comments

Comments

@remkop
Copy link
Owner

remkop commented Feb 22, 2022

Most modules other than the main picocli module do not have package-info.html file.


Javadoc for CommandLine.Help.ColorScheme.Builder, the ansi(CommandLine.Help.Ansi ansi) setter method incorrectly says

Returns the Ansi setting

that should be

Sets the Ansi setting


The CommandLine.Help.Ansi.Style.parse(String) javadoc says:

strings starting with "bg(" are delegated to bg(String), others are delegated to bg(String).

That should be

others are delegated to {@link #fg(String)}.


@remkop remkop added this to the 4.7 milestone Feb 22, 2022
@remkop remkop closed this as completed in fd758b1 Feb 23, 2022
@remkop remkop changed the title DOC: fix javadoc typos and incorrect links DOC: javadoc improvements: typos, incorrect links, package-info Feb 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant