From 9eb00f5a16a08e5a555a16e37ad62d23488594c9 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Fri, 6 Jan 2017 16:00:08 +0000 Subject: [PATCH] builder: meet level 3 javadoc --- builder/pom.xml | 2 +- .../CheckstyleRulesetBuilderApplication.java | 5 +++ .../checkstyle/ruleset/builder/RuleLevel.java | 2 +- .../ruleset/builder/RuleParent.java | 2 +- .../ruleset/builder/RuleSource.java | 2 +- .../ruleset/builder/package-info.java | 31 +++++++++++++++++++ 6 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/package-info.java diff --git a/builder/pom.xml b/builder/pom.xml index b65ab86..fa18654 100644 --- a/builder/pom.xml +++ b/builder/pom.xml @@ -25,7 +25,7 @@ 7.3 1.22.0 2.0.0-SNAPSHOT - 2-naming + 3-javadoc diff --git a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/CheckstyleRulesetBuilderApplication.java b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/CheckstyleRulesetBuilderApplication.java index 6fd5658..4d04c83 100644 --- a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/CheckstyleRulesetBuilderApplication.java +++ b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/CheckstyleRulesetBuilderApplication.java @@ -40,6 +40,11 @@ import org.springframework.boot.context.properties.EnableConfigurationProperties @SpringBootApplication public class CheckstyleRulesetBuilderApplication { + /** + * Main methods. + * + * @param args Command line arguments. + */ public static void main(final String[] args) { SpringApplication.run(CheckstyleRulesetBuilderApplication.class, args); } diff --git a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleLevel.java b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleLevel.java index b118770..b88e4a7 100644 --- a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleLevel.java +++ b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleLevel.java @@ -25,7 +25,7 @@ SOFTWARE. package net.kemitix.checkstyle.ruleset.builder; /** - * . + * Ruleset levels. * * @author Paul Campbell (pcampbell@kemitix.net) */ diff --git a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleParent.java b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleParent.java index 5817842..576023e 100644 --- a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleParent.java +++ b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleParent.java @@ -25,7 +25,7 @@ SOFTWARE. package net.kemitix.checkstyle.ruleset.builder; /** - * . + * Module parent to contain a rule. * * @author Paul Campbell (pcampbell@kemitix.net) */ diff --git a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleSource.java b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleSource.java index eaac328..0e7db03 100644 --- a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleSource.java +++ b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleSource.java @@ -25,7 +25,7 @@ SOFTWARE. package net.kemitix.checkstyle.ruleset.builder; /** - * . + * The origin of the rule. * * @author Paul Campbell (pcampbell@kemitix.net) */ diff --git a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/package-info.java b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/package-info.java new file mode 100644 index 0000000..3be5c06 --- /dev/null +++ b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/package-info.java @@ -0,0 +1,31 @@ +/* +The MIT License (MIT) + +Copyright (c) 2016 Paul Campbell + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +/** + * Ruleset Builder. + * + * @author Paul Campbell (pcampbell@kemitix.net) + */ + +package net.kemitix.checkstyle.ruleset.builder;