Skip to content

Commit

Permalink
Remove useless documentation related files and Javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jiaqi Guo committed Jan 16, 2019
1 parent a4ad073 commit 3854b3b
Show file tree
Hide file tree
Showing 10 changed files with 9 additions and 121 deletions.
9 changes: 9 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,13 @@
<url>s3://${dist.bucketName}/projects/jcli</url>
</site>
</distributionManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.7.1</version>
</plugin>
</plugins>
</build>
</project>
5 changes: 0 additions & 5 deletions src/site/apt/index.apt

This file was deleted.

Binary file removed src/site/image/logo.xcf
Binary file not shown.
1 change: 0 additions & 1 deletion src/site/resources/css/site.css

This file was deleted.

Binary file removed src/site/resources/images/logo.png
Binary file not shown.
41 changes: 0 additions & 41 deletions src/site/site.xml

This file was deleted.

8 changes: 0 additions & 8 deletions src/test/java/org/cyclopsgroup/jcli/MultiActionTest.java
Original file line number Diff line number Diff line change
@@ -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<String, Class<?>> clis = new HashMap<String, Class<?>>();
Expand Down
36 changes: 0 additions & 36 deletions src/test/java/org/cyclopsgroup/jcli/Simple.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="mailto:[email protected]">Jiaqi Guo</a>
*/
@Cli(name = "sample", description = "A test")
public class Simple implements AutoCompletable {
public List<String> suggestArgument(String partialArgument) {
Expand Down Expand Up @@ -48,76 +42,46 @@ public List<String> suggestOption(String optionName, String partialOption) {

private List<String> 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<String> 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<String> values) {
Expand Down
Original file line number Diff line number Diff line change
@@ -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 <a href="mailto:[email protected]">Jiaqi Guo</a>
*/
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());
Expand Down
15 changes: 0 additions & 15 deletions src/test/java/org/cyclopsgroup/jcli/jline/CliCompletorTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -17,11 +15,6 @@
import org.junit.Before;
import org.junit.Test;

/**
* Test case for {@link CliCompletor}
*
* @author <a href="mailto:[email protected]">Jiaqi Guo</a>
*/
public class CliCompletorTest {
private List<Candidate> candidates;

Expand All @@ -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());
Expand All @@ -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() {
Expand Down

0 comments on commit 3854b3b

Please sign in to comment.