javadoc fixes for gestalt-module #156

soloturn · 2024-11-18T05:11:02Z

No description provided.

BenjaminAmos

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

gestalt-module/src/main/java/org/terasology/gestalt/module/sandbox/ModuleSecurityManager.java

...alt-module/src/main/java/org/terasology/gestalt/module/sandbox/ModuleSecurityPermission.java

...t-module/src/main/java/org/terasology/gestalt/module/sandbox/SetUnionPermissionProvider.java

gestalt-module/src/main/java/org/terasology/gestalt/naming/VersionRange.java

gestalt-module/src/main/java/org/terasology/gestalt/i18n/I18nMap.java

gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java

gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleMetadata.java

gestalt-module/src/main/java/org/terasology/gestalt/naming/Name.java

gestalt-module/src/main/java/org/terasology/gestalt/naming/Version.java

gestalt-module/src/main/java/org/terasology/gestalt/naming/VersionRange.java

Co-authored-by: BenjaminAmos <[email protected]>

BenjaminAmos

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

BenjaminAmos · 2024-12-29T09:58:00Z

gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java

     * @return Information on the contents on this module
     */
    public ClassIndex getClassIndex() {
        return classIndex;
    }

    /**
-     * @return A predicate that specifies whether a given class from the main classloader is a
-     * member of this module
+     * Gets a predicate which that specifies whether a given class from the main classloader is a


Suggested change

* Gets a predicate which that specifies whether a given class from the main classloader is a

* Gets a predicate that specifies whether a given class from the main classloader is a

BenjaminAmos · 2024-12-29T09:58:16Z

gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java

@@ -84,6 +84,9 @@ public class ModuleEnvironment implements AutoCloseable, Iterable<Module> {
    private final ModuleFileSource resources;

    /**
+     * Creates a ModuleEnvironment with give bean context, modules and permissionProviderFactory.


Suggested change

* Creates a ModuleEnvironment with give bean context, modules and permissionProviderFactory.

* Creates a ModuleEnvironment with a given bean context, modules and permissionProviderFactory.

BenjaminAmos · 2024-12-29T09:58:29Z

gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java

@@ -93,6 +96,9 @@ public ModuleEnvironment(BeanContext beanContext, Iterable<Module> modules, Perm
    }

    /**
+     * Creates a ModuleEnvironment with give bean context, modules, permissionProviderFactory, and classLoaderSupplier.


Suggested change

* Creates a ModuleEnvironment with give bean context, modules, permissionProviderFactory, and classLoaderSupplier.

* Creates a ModuleEnvironment with a given bean context, modules, permissionProviderFactory, and classLoaderSupplier.

BenjaminAmos · 2024-12-29T09:58:39Z

gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java

@@ -103,14 +109,19 @@ public ModuleEnvironment(BeanContext beanContext, Iterable<Module> modules, Perm
    }

    /**
+     * Creates a ModuleEnvironment with give bean context, modules, permissionProviderFactory,


Suggested change

* Creates a ModuleEnvironment with give bean context, modules, permissionProviderFactory,

* Creates a ModuleEnvironment with a given bean context, modules, permissionProviderFactory,

BenjaminAmos · 2024-12-29T09:58:53Z

gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleEnvironment.java

@@ -103,14 +109,19 @@ public ModuleEnvironment(BeanContext beanContext, Iterable<Module> modules, Perm
    }

    /**
+     * Creates a ModuleEnvironment with give bean context, modules, permissionProviderFactory,
+     * classLoaderSupplier, and apiClassLoader.


Suggested change

* classLoaderSupplier, and apiClassLoader.

* classLoaderSupplier and apiClassLoader.

BenjaminAmos · 2024-12-29T10:00:53Z

gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleFactory.java

    @Inject // TODO use another constructor.
    public ModuleFactory() {
        this(Thread.currentThread().getContextClassLoader());
    }

    /**
+     * Creates a Module out of a file Module.json in standard library path.


Suggested change

* Creates a Module out of a file Module.json in standard library path.

* Creates a module using a module.json file from the standard library path.

BenjaminAmos · 2024-12-29T10:01:12Z

gestalt-module/src/main/java/org/terasology/gestalt/module/ModuleFactory.java

@@ -90,6 +97,7 @@ public ModuleFactory(String defaultCodeSubpath, String defaultLibsSubpath) {
    }

    /**
+     * Constructor with classLoader, code, moodule subpath, metadata loaders.


Suggested change

* Constructor with classLoader, code, moodule subpath, metadata loaders.

* Constructor with classLoader, code, module subpath, metadata loaders.

BenjaminAmos · 2024-12-29T10:03:26Z

gestalt-module/src/main/java/org/terasology/gestalt/module/sandbox/JavaModuleClassLoader.java

@@ -110,19 +122,27 @@ public static ModuleClassLoader create(Module module, ClassLoader parent, Permis
    }

    /**
+     * Get module id this classloarder belongs to.


Suggested change

* Get module id this classloarder belongs to.

* Get module id this classloader belongs to.

BenjaminAmos · 2024-12-29T10:04:48Z

gestalt-module/src/main/java/org/terasology/gestalt/naming/Name.java

    public Name(String name) {
        Preconditions.checkNotNull(name);
        this.originalName = name;
        this.normalisedName = name.toLowerCase(Locale.ENGLISH);
    }

    /**
-     * @return Whether this name is empty (equivalent to an empty string)
+     * Whether this name is empty (equivalent to an empty string)
+     * @return true if emppty


Suggested change

* @return true if emppty

* @return true if empty

soloturn force-pushed the javadoc branch 3 times, most recently from 1d1a902 to 16dfb69 Compare November 18, 2024 06:47

soloturn requested review from BenjaminAmos and jdrueckert November 19, 2024 07:26

BenjaminAmos requested changes Nov 19, 2024

View reviewed changes

soloturn force-pushed the javadoc branch from a505d2f to 3f3da58 Compare November 25, 2024 13:50

soloturn requested a review from BenjaminAmos December 20, 2024 17:27

BenjaminAmos requested changes Dec 24, 2024

View reviewed changes

soloturn force-pushed the javadoc branch 3 times, most recently from b157332 to 96d015d Compare December 25, 2024 12:20

javadoc fixes for gestalt-module

ac1aca7

Co-authored-by: BenjaminAmos <[email protected]>

soloturn force-pushed the javadoc branch from 96d015d to ac1aca7 Compare December 25, 2024 12:23

soloturn requested a review from BenjaminAmos December 28, 2024 22:39

BenjaminAmos requested changes Dec 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

javadoc fixes for gestalt-module #156

javadoc fixes for gestalt-module #156

soloturn commented Nov 18, 2024

BenjaminAmos left a comment

BenjaminAmos left a comment

BenjaminAmos Dec 29, 2024

BenjaminAmos Dec 29, 2024

BenjaminAmos Dec 29, 2024

BenjaminAmos Dec 29, 2024

BenjaminAmos Dec 29, 2024

BenjaminAmos Dec 29, 2024

BenjaminAmos Dec 29, 2024

BenjaminAmos Dec 29, 2024

BenjaminAmos Dec 29, 2024

	* Gets a predicate which that specifies whether a given class from the main classloader is a
	* Gets a predicate that specifies whether a given class from the main classloader is a

	* Creates a ModuleEnvironment with give bean context, modules and permissionProviderFactory.
	* Creates a ModuleEnvironment with a given bean context, modules and permissionProviderFactory.

	* classLoaderSupplier, and apiClassLoader.
	* classLoaderSupplier and apiClassLoader.

	* Creates a Module out of a file Module.json in standard library path.
	* Creates a module using a module.json file from the standard library path.

	* Constructor with classLoader, code, moodule subpath, metadata loaders.
	* Constructor with classLoader, code, module subpath, metadata loaders.

	* Get module id this classloarder belongs to.
	* Get module id this classloader belongs to.

javadoc fixes for gestalt-module #156

Are you sure you want to change the base?

javadoc fixes for gestalt-module #156

Conversation

soloturn commented Nov 18, 2024

BenjaminAmos left a comment

Choose a reason for hiding this comment

BenjaminAmos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment