diff options
Diffstat (limited to 'base/src/main/java/bjc/utils/components/IDescribedComponent.java')
| -rw-r--r-- | base/src/main/java/bjc/utils/components/IDescribedComponent.java | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/base/src/main/java/bjc/utils/components/IDescribedComponent.java b/base/src/main/java/bjc/utils/components/IDescribedComponent.java index 952b375..78af4bc 100644 --- a/base/src/main/java/bjc/utils/components/IDescribedComponent.java +++ b/base/src/main/java/bjc/utils/components/IDescribedComponent.java @@ -2,30 +2,32 @@ package bjc.utils.components; /** * Represents a optional component that has status information associated with - * it + * it. * * @author ben * */ public interface IDescribedComponent extends Comparable<IDescribedComponent> { /** - * Get the author of this component + * Get the author of this component. * - * Providing this is optional, with "Anonymous" as the default author + * Providing this is optional, with "Anonymous" as the default author. * - * @return The author of the component + * @return + * The author of the component. */ default String getAuthor() { return "Anonymous"; } /** - * Get the description of this component + * Get the description of this component. * * Providing this is optional, with the default being a note that no - * description was provided + * description was provided. * - * @return The description of the component + * @return + * The description of the component */ default String getDescription() { return "No description provided."; @@ -34,18 +36,20 @@ public interface IDescribedComponent extends Comparable<IDescribedComponent> { /** * Get the name of this component. * - * This is the only thing required of all components + * This is the only thing required of all components. * - * @return The name of the component + * @return + * The name of the component. */ String getName(); /** - * Get the version of this component + * Get the version of this component. * - * Providing this is optional, with "1" as the default version + * Providing this is optional, with "1" as the default version. * - * @return The version of this component + * @return + * The version of this component. */ default int getVersion() { return 1; @@ -61,4 +65,4 @@ public interface IDescribedComponent extends Comparable<IDescribedComponent> { return res; } -}
\ No newline at end of file +} |
