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.

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

javadoc fixes for gestalt-module #156

Merged
merged 1 commit into from
Jan 8, 2025
Merged

javadoc fixes for gestalt-module #156

merged 1 commit into from
Jan 8, 2025

Conversation

soloturn
Copy link
Contributor

No description provided.

@soloturn soloturn force-pushed the javadoc branch 3 times, most recently from 1d1a902 to 16dfb69 Compare November 18, 2024 06:47
BenjaminAmos
BenjaminAmos requested changes Nov 19, 2024
View reviewed changes
Copy link
Contributor

@BenjaminAmos BenjaminAmos left a comment

Choose a reason for hiding this comment

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

At an initial glance, I have highlighted many spelling errors in the comments introduced here.

For getters, I would prefer that the description states that they return something, so "Returns a thing" is preferred over "Get a thing"/"Gets a thing".

Just because a constructor is a default constructor, that does not mean that you can describe it as "Default constructor". Even though the purpose is usually obvious, if you are aiming for complete JavaDoc coverage then we should at least make it quality documentation.

gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/sandbox/ModuleSecurityManager.java Outdated Show resolved Hide resolved
...alt-module/src/main/java/org/terasology/gestalt/module/sandbox/ModuleSecurityPermission.java Outdated Show resolved Hide resolved
...t-module/src/main/java/org/terasology/gestalt/module/sandbox/SetUnionPermissionProvider.java Outdated Show resolved Hide resolved
...t-module/src/main/java/org/terasology/gestalt/module/sandbox/SetUnionPermissionProvider.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/naming/VersionRange.java Outdated Show resolved Hide resolved
BenjaminAmos
BenjaminAmos requested changes Dec 24, 2024
View reviewed changes
gestalt-module/src/main/java/org/terasology/gestalt/i18n/I18nMap.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleMetadata.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleMetadata.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/naming/Name.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/naming/Version.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/naming/Version.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/naming/Version.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/naming/VersionRange.java Outdated Show resolved Hide resolved
@soloturn soloturn force-pushed the javadoc branch 4 times, most recently from 96d015d to ac1aca7 Compare December 25, 2024 12:23
BenjaminAmos
BenjaminAmos previously requested changes Dec 29, 2024
View reviewed changes
Copy link
Contributor

@BenjaminAmos BenjaminAmos left a comment

Choose a reason for hiding this comment

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

I am hoping that this will be the last set of changes needed.

gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleFactory.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleFactory.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/sandbox/JavaModuleClassLoader.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/naming/Name.java Outdated Show resolved Hide resolved
@soloturn soloturn requested a review from BenjaminAmos January 2, 2025 04:18
@soloturn soloturn removed the request for review from jdrueckert January 2, 2025 17:36
BenjaminAmos
BenjaminAmos previously requested changes Jan 3, 2025
View reviewed changes
Copy link
Contributor

@BenjaminAmos BenjaminAmos left a comment

Choose a reason for hiding this comment

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

There were a few new JavaDoc additions that seem to have been added since I last checked. They are not ideal, so some more changes may be sadly still be required. Thanks for persisting with this!

gestalt-module/src/main/java/org/terasology/gestalt/module/resources/ClasspathFileSource.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/resources/ClasspathFileSource.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/resources/ClasspathFileSource.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/resources/ClasspathFileSource.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/resources/ClasspathFileSource.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/sandbox/APIScanner.java Outdated Show resolved Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/sandbox/APIScanner.java Outdated Show resolved Hide resolved
@soloturn soloturn requested a review from BenjaminAmos January 8, 2025 00:17
BenjaminAmos
BenjaminAmos approved these changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@BenjaminAmos BenjaminAmos left a comment

Choose a reason for hiding this comment

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

Thank you for persisting with this!

@BenjaminAmos BenjaminAmos merged commit ec13bae into develop Jan 8, 2025
5 checks passed
@BenjaminAmos BenjaminAmos deleted the javadoc branch January 8, 2025 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BenjaminAmos BenjaminAmos BenjaminAmos approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@soloturn @BenjaminAmos