diff --git a/pom.xml b/pom.xml index 34ada26..9bcb07a 100644 --- a/pom.xml +++ b/pom.xml @@ -75,4 +75,13 @@ s3://${dist.bucketName}/projects/jcli + + + + org.apache.maven.plugins + maven-site-plugin + 3.7.1 + + + diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt deleted file mode 100644 index 7dc1e2a..0000000 --- a/src/site/apt/index.apt +++ /dev/null @@ -1,5 +0,0 @@ -JCLI - Java annotation based command line argument parser - - JCLI is a small Java library that parses argument array and pass result to POJO annotated with predefined annotations. Have a look at {{{apidoc/index.html}API}} for more details. - - JCLI is used by {{{http://www.cyclopsgroup.org/projects/jmxterm}jmxterm}} for command line parsing and validation. \ No newline at end of file diff --git a/src/site/image/logo.xcf b/src/site/image/logo.xcf deleted file mode 100644 index c0e4dfc..0000000 Binary files a/src/site/image/logo.xcf and /dev/null differ diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css deleted file mode 100644 index 727906e..0000000 --- a/src/site/resources/css/site.css +++ /dev/null @@ -1 +0,0 @@ -@import url("http://www.cyclopsgroup.org/css/cyclopsgroup-m2-site.css"); \ No newline at end of file diff --git a/src/site/resources/images/logo.png b/src/site/resources/images/logo.png deleted file mode 100644 index 38dc853..0000000 Binary files a/src/site/resources/images/logo.png and /dev/null differ diff --git a/src/site/site.xml b/src/site/site.xml deleted file mode 100644 index 2648cb6..0000000 --- a/src/site/site.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - JCLI - images/logo.png - index.html - - - - http://cyclops-group.sourceforge.net/wiki/images/cyclopsgroup-logo.png - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/src/test/java/org/cyclopsgroup/jcli/MultiActionTest.java b/src/test/java/org/cyclopsgroup/jcli/MultiActionTest.java index 81f7703..fb39d76 100644 --- a/src/test/java/org/cyclopsgroup/jcli/MultiActionTest.java +++ b/src/test/java/org/cyclopsgroup/jcli/MultiActionTest.java @@ -1,20 +1,12 @@ package org.cyclopsgroup.jcli; import static org.junit.Assert.assertEquals; - import java.util.Arrays; import java.util.HashMap; import java.util.Map; - import org.junit.Test; -/** - * A test to go over multi action use case - */ public class MultiActionTest { - /** - * Happy case of multi actions. - */ @Test public void testMultiAction() throws InstantiationException, IllegalAccessException { Map> clis = new HashMap>(); diff --git a/src/test/java/org/cyclopsgroup/jcli/Simple.java b/src/test/java/org/cyclopsgroup/jcli/Simple.java index 28c1ce4..ee829cc 100644 --- a/src/test/java/org/cyclopsgroup/jcli/Simple.java +++ b/src/test/java/org/cyclopsgroup/jcli/Simple.java @@ -3,18 +3,12 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; - import org.apache.commons.lang3.builder.ReflectionToStringBuilder; import org.cyclopsgroup.jcli.annotation.Argument; import org.cyclopsgroup.jcli.annotation.Cli; import org.cyclopsgroup.jcli.annotation.MultiValue; import org.cyclopsgroup.jcli.annotation.Option; -/** - * Example bean for testing purpose - * - * @author Jiaqi Guo - */ @Cli(name = "sample", description = "A test") public class Simple implements AutoCompletable { public List suggestArgument(String partialArgument) { @@ -48,76 +42,46 @@ public List suggestOption(String optionName, String partialOption) { private List values; - /** - * @return An integer option - */ public final int getIntField() { return intField; } - /** - * @return One string option - */ public final String getStringField1() { return stringField1; } - /** - * @return Another string option - */ public final String getStringField2() { return stringField2; } - /** - * @return Arguments - */ public final List getValues() { return values; } - /** - * @return Boolean flag - */ public final boolean isBooleanField() { return booleanField; } - /** - * @param booleanField A flag option - */ @Option(name = "b", longName = "boolean", description = "Test boolean field") public final void setBooleanField(boolean booleanField) { this.booleanField = booleanField; } - /** - * @param intField An integer option - */ @Option(name = "i", longName = "tint", description = "Test int value") public final void setIntField(int intField) { this.intField = intField; } - /** - * @param stringField1 One string option - */ @Option(name = "f", longName = "field1", required = true) public final void setStringField1(String stringField1) { this.stringField1 = stringField1; } - /** - * @param stringField2 Another string option - */ @Option(name = "2", longName = "field2") public final void setStringField2(String stringFIeld2) { this.stringField2 = stringFIeld2; } - /** - * @param values Arguments - */ @MultiValue(listType = ArrayList.class) @Argument public final void setValues(List values) { diff --git a/src/test/java/org/cyclopsgroup/jcli/jline/ArgumentsInspectorTest.java b/src/test/java/org/cyclopsgroup/jcli/jline/ArgumentsInspectorTest.java index cd80087..f973c3f 100644 --- a/src/test/java/org/cyclopsgroup/jcli/jline/ArgumentsInspectorTest.java +++ b/src/test/java/org/cyclopsgroup/jcli/jline/ArgumentsInspectorTest.java @@ -1,35 +1,20 @@ package org.cyclopsgroup.jcli.jline; import static org.junit.Assert.assertEquals; - import java.beans.IntrospectionException; - import org.cyclopsgroup.jcli.ArgumentProcessor; import org.cyclopsgroup.jcli.Simple; import org.junit.Before; import org.junit.Test; -/** - * Test case of {@link ArgumentsInspector} - * - * @author Jiaqi Guo - */ public class ArgumentsInspectorTest { private ArgumentsInspector ins; - /** - * Setup object to test - * - * @throws IntrospectionException - */ @Before public void setUp() throws IntrospectionException { ins = new ArgumentsInspector(ArgumentProcessor.forType(Simple.class).createParsingContext()); } - /** - * Test state change of a sevies of argument consumption - */ @Test public void testConsume() { assertEquals(ArgumentsInspectorState.READY, ins.getState()); diff --git a/src/test/java/org/cyclopsgroup/jcli/jline/CliCompletorTest.java b/src/test/java/org/cyclopsgroup/jcli/jline/CliCompletorTest.java index 5e0bbbe..7c17fa3 100644 --- a/src/test/java/org/cyclopsgroup/jcli/jline/CliCompletorTest.java +++ b/src/test/java/org/cyclopsgroup/jcli/jline/CliCompletorTest.java @@ -2,11 +2,9 @@ import static org.hamcrest.CoreMatchers.is; import static org.junit.Assert.assertThat; - import java.beans.IntrospectionException; import java.util.ArrayList; import java.util.List; - import org.cyclopsgroup.caff.token.QuotedValueTokenizer; import org.cyclopsgroup.jcli.Simple; import org.jline.reader.Candidate; @@ -17,11 +15,6 @@ import org.junit.Before; import org.junit.Test; -/** - * Test case for {@link CliCompletor} - * - * @author Jiaqi Guo - */ public class CliCompletorTest { private List candidates; @@ -33,11 +26,6 @@ public class CliCompletorTest { private ParsedLine parsedLine; - /** - * Set up completor to test - * - * @throws IntrospectionException - */ @Before public void setUp() throws IntrospectionException { cc = new CliCompletor(new Simple(), new QuotedValueTokenizer()); @@ -47,9 +35,6 @@ public void setUp() throws IntrospectionException { parsedLine = context.mock(ParsedLine.class); } - /** - * @throws IntrospectionException - */ @Test public void testCompleteWithEmpty() throws IntrospectionException { context.checking(new Expectations() {