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.

Sign up for GitHub

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

Jump to bottom

update SettingsDialog javadoc and comments #1620

Merged

stephengold merged 1 commit into master from sgold-gamesettings

Oct 22, 2021

Member

stephengold commented Oct 15, 2021

The inline documentation for the SettingsDialog class is painfully out of date:

It refers to non-existent classes PropertiesDialog and GameSettings that have (apparently) been renamed
It refers to a "properties file" or "properties.cfg" for backing storage that has (apparently) been re-implemented using java.util.prefs.Preferences
The javadoc is vague about what SettingsDialog is and does.
The javadoc doesn't make it clear that it's for desktop only.

This PR attempts to remedy these defects. All changes are to comments only.


          SettingsDialog: update the javadoc and comments

d70d3b2

stephengold added the Documentation label

stephengold merged commit 8e415a5 into master

stephengold deleted the sgold-gamesettings branch

October 22, 2021 00:40

stephengold added this to the v3.5.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment