From 3854b3bb3c26bbe7407bf1b6600d8b25592d398e Mon Sep 17 00:00:00 2001 From: Jiaqi Guo Date: Wed, 16 Jan 2019 12:29:27 -0800 Subject: [PATCH] Remove useless documentation related files and Javadocs --- pom.xml | 9 ++++ src/site/apt/index.apt | 5 --- src/site/image/logo.xcf | Bin 12465 -> 0 bytes src/site/resources/css/site.css | 1 - src/site/resources/images/logo.png | Bin 3862 -> 0 bytes src/site/site.xml | 41 ------------------ .../cyclopsgroup/jcli/MultiActionTest.java | 8 ---- .../java/org/cyclopsgroup/jcli/Simple.java | 36 --------------- .../jcli/jline/ArgumentsInspectorTest.java | 15 ------- .../jcli/jline/CliCompletorTest.java | 15 ------- 10 files changed, 9 insertions(+), 121 deletions(-) delete mode 100644 src/site/apt/index.apt delete mode 100644 src/site/image/logo.xcf delete mode 100644 src/site/resources/css/site.css delete mode 100644 src/site/resources/images/logo.png delete mode 100644 src/site/site.xml 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 c0e4dfc5dcde06d3543c6c7ac1f333d8a2e684d3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 12465 zcmeHNdw5mFwV!iNP69~?Nq8jT5f0%M0w)Q9Ja||Y0n1ZLtx}|DNKV4RkU(-U2~wg^ zd%YDgyb+~%K@`LXT1BCiLO(x=6k9;#`Du9zo>nyd-m*^HEU+CoLuj;>8_Hj99NDv&m)Ae9mAgz2(Ji;&4xd%Ak7As3qirv8WI2r zgtV>2v}*(V`=MLpqFHxV!L(_fd>_h!m67)qdNO^UY*(?@H^p`T@X=#g6K$nNdkZ~TK5s$3 zE6-O5^1D9wzqrfPnMFQtPN^%;ljCEP1tsoj1=$`ft`ZNOm_)HR8}8q?f6Cw9f%FuQ zH+PE9^YdK0R@koHPbtKQmyqI%p?8=*3Uw4FD#O3(o)s;QRR z0F{o)bEZ~3wG%}(#Zv2`(olKU)T)OLL{a5h>NTiTRGu-l>aK%OR31yMgX)LM)23Ek zbu$!Iwx!lW^+n}LQ>!kzIf`nsrPe^Dpz?&NRc9THqRORIzg$!B1x!8L@Py@xM3T*`e@C~{m;cBxT;m8Ct$J3#GQCOS(S^$r@kWFUW5wy z&`tDC58_cW_5e7!CS#CNB(;>C=wVVjTO$;M`iW>KWXv&IRfHjOf@&*bgbe8 zRwvs6WqXa(xlV}Hpq7GCUNXi&%nq1`L^K{)1xh`M0S6N$qJ#|iBaJ?FfC|v+0E|=- z8Gmm$1(;1b8`#JWcslNhA+ejpLJ(3P;`?y^uxeOd!SZ#M zhnVG`vdkE#dYI*Q_2o#Eu~;#zH&`9W;)^VvX3@^#Pgyh{X4bZ2aXo8W3%5{D67?n; zN;DQo23K>f%@v74Z6?}5Gzmx=QD*%`va`s}BYQrKY~&@f-BJ6i-WubCgBrH%n+VgYIjXv9 z<4j37yj_N_MfidXyyoth#fF~-ba@ZVB}X{(CC1<7;C;>mF;%IpZv~ymtJ8U zSq9#&{c>A=9A?7^ol&V<@d*LKuaEfJafOF1*O7b*x-`trm@)D)1I0nn3(M>r-EFzR zj+baIorgK1Kj!>JbNJUV#2rKgmr>Ud0%3`;UQYBdQ36qnK>Xj&Kz&H02(^f41<|8K z5T5V?uQ6QvQw0LiEt4(K06sxXGWw`ad?zwzgH+@j2JMO3w! zy=v{+l{4FjG@*WvsgMWl0{dD#M>~>eHn);tE(&(<$JwzW9wIbS~yCMG5@+V4n zG1o&|Ve~3qP;M*tFI>EA4d(0SAJ)ILZ1JLn<&JXs%mC~MDhW$O{g$&>KvYV!i710B z$bNy&b__%Dte;6#Nb~_wifMU;mKROSG_voq{t2QPL}pk?rls>L zEic&FW;*NNVSO=C0ntZ9Nv7pBT7GL9P0Q=FL>xey1IWI~`dLJI zL|ch^(K67qthCW`AlZ$qf0Ae_(eH>7Xc=^aZNficIf(2A*8iNyOY|{OylGiQ%d@8C z56HgG`Z+|oMB9kE)3Vu3TAnd2?&u8d*sL3SU$v0AXK@Zq7b+D#54FTnTo)+S zDi2B-I1i^Y4S^-zDbX{aOqZMjLIaA6sg% zrS?JLu-sbP^gzaLQ!TXAUMSSHvd+_EEmdx*Jy1AZM=DdR2he|AOMsaf!9)}Njwjt8GP{onG0k-HyLa?SpCaH7o3>|`CmTex6L;hwU`lMAc@@|oLnOyeh)&nlwbmQ&_N&^LX(lW z8#{u14nxFeHd4=lvI*I069fKOyoTBZ#;`qfjtAZY*l!TbC8);Jxm|S7a!+3z`8x8n zZK~^*s<6}?DA=5B3+-RDbk!;Nh1|NRJg{8Oj^!&Iq4%6N*I0Y{%q#Ss2}F+(y-4ID zIt)W~oG6Cee-Vu*$|PDr)S2iI8$4mUV>HP%Bp)W4OthRRj_3dlPuc*n<*Y@}gvzp1 z7bx`e6yqw)U&V$4m2IhRQ0%kK)M_2#FnZ>(RCg$x*RdR^u@+LOaxB#Y3d8x0&D2;@ zeNj|XEENxh`M{E+R_n2GKzS|I6AG~%E0-F}HkE3sr4pd9Ih?ndTD^hY3GVT@rFubO zb3t^VMi5D-%Cl5&DC}aDc2ldjM20A{<3r+aBFchLu9aY+%){wpJg3B7#SScQ#^DGI z7NhlT2u`sw=u^(q6FBs$6CCOpB%N<^tT)@q{)X_g06-bBg?LvBnBen|!xl?=)Ctm` zMDi)k{z3=A))V;w_Xc;sKBC%@lK<)PG#-Cr1A;c*wYAd;x+8&L^n*q&&2|YT@D)Yv0>>oMYs~3Aje5F%B-# z=~M?TRc)y~rZN&fx~x-mS-?|`I)$7H9C#9A;0U;eJmDn#PeAO@-G%xLvn4BoF*ZhA zDf=K78a(*U=4WX1B^`^8gK%K=G`vndi!D&?Bw5v#@H!yK4npnI7}9I6HwQKnDkKid z-|Y#G`qQu?q1;f|OmG;WHqO7a7-ubG!R-EsPdG$RK@5ZXlcn}rYL%siKw+XQXJPa= zi866aHxMSGK7k|>;F=7HGLb<168Nk!ulj5lzTSnCxkb|7XC5>f?MFgxl?Qc#|98!U zCMTw(rl@-^T>lnpFysC6XbW0ipKRZ z2|~1=Aw+DA5S^C@(G`=|?YIy<{s7r0MEp@9dKL+hfP87fhq(V<$SZ6E2a3UviIC#5 zraUM&LNguOlm|uh`G@kL4cw?H589LmMZyUA$)-H$?azZYScpw|(55`-9h3)c;F(Q% z(55`-ZO(%>@V=%z=)Zm*w83;XFH4_e>dJ1GxZ->H9k9<;tE-%lQNF!G=iA;l0TqW%wgQ2SG`V@L6F09 z!`3|lG66CbG7Iu6$V$i?kgbqikRy=ukQ%fZ3~2{RVB5&!-Psa`{@uX>=eh^OIEZ73 z>lH{W0WSWqn?Drh6%V05;HsZ*7D5JRW<8!;STHj`o5g>YTVlhkyOJU-RNqawY*MNa z$xlO`hr9?`*Vra$A#7GbHb6dr?0|d@!B1c%_q10uul8zRZSU`2ZQXkvxaV5!g0J;Dn;$bRyKhy|oZwkb zbPomQ!*HB4uTuG>Jr-pz@tL3n1Q>gE_Jy-V)r0JMq~43Qgs<9@^4c;xC)9g`-v?@* z5&iMA18d-0|Cgk)vyC$UHim*(tpS8{v~!}|Tp$*J2y?3!=K|may>9f1&&P$cuZe$x zD-u}AAtT`2uh`W9EQ0EudxHO3$rBA@8>T$`DF--ULNZ-s%DWKQ=}u80pO-Pqv2lw) zi!g1M$fiWgCh6F*CQkJ2H$+}?W7{&O7bRa!oevUOaU;&yOXd2F)pHBxukJU2b`j2bbF znDZ%@gnSa_51DAD#!1$yd>ll6ZFVO*0mcQ>#dA$0gy<+O(i4jEkS^gS@$nEWucWtB`q*e*o`;dhh;(1| zyO{MeKSvA%z0{G(gf=H92XN~0O6j(b_pV&33dnu19GKq!RQ-V-@2vha;Mp;A!L$wA z7UXldp8mz@W3V!-mpjY@i3+3jPM`W;UB19v$R)LKNtZh_b3x=E$JwD&oWMOt!BoHC z>z3Zc9xBy$+1*WiwOdg8)482hs(36gRT;KCTHga+7s;4El7IUa&nb#H*RyT+VWD0{ ziirnMdl`f%O68Q%_nM6_eFn5U9uI!Hw~){XEo{)tgoxDC^{Ydy=ZiUNI0AX^y8M!V ziTd_Iv*@x?Z9{)0+3Cq^vSle#ARzX6p69IHOhbhATxIc0+)4Jr{DF<2@vkPgX9_EB z0MX_GG5@&RF)eMfg$T zVR6_=VvL`#;mN3Y*@u~GljX~?cfHSryHQLBGsiuzR;-DaF55sq`r64EX+Ggs9k%Bh z;Ova1Gwb;-MJa(sT;$#db{|s~63FV___E+>4~K#tsvz0a$^~`yaP0TI>7AEHfnN_C zfA9iAGV1gTpM&PY(QhHy8*rXWjT6N=N|;zmo%XO?^3=jN#E*1&w7e3mbq`yuqQTnj zpFmVn>O9_&z6CZzsdK|Tq6pyd0hNoE3jINCdLZ(8cH8CP`_zBLn)d@!V&KejIu%PL zTHPv3EvA-kdCE5_niLz;aSo4*g+0_b8U}R`m_4JfEwsV>G<11N$}_NMvC^1R7rOb9 zRKglwT^4+&yU9T7N0G}fSRWSu`7t+)Y9VjznSmUWmY>&mcDP{^TAYfOa*wHEnt#!H zM^59;otpqi!sHN9WG4695OEy+A9zHLKq?K$_Fq|HZ6hWUqTYU8u>~PM%#MrzGm!Cb zb{BR*0MwQ+OFSU5n-dE22KI^S5yPvQ#&e_RauT+uuyo7bTKjJpqT?JT4S+MZkD?9z@ zo*?h9y-N4?i=MH9}zQTvf7p$7JD2>O{RjHx5>kM zC&N!$UTUF-CBCng`5L{=%(hP20y;Qz&@e+YZi-ikLGj;jAgs3=ap< zs9JoL@jWO=mlplZ_|5Km5cn?d@|Bb@*0zfkm;8|a6CBDF@hqatxPS+4=c;oX-F_c) zuPZdkzAOvYh21*kH$qlLYB^B-jf|byV3Ud>P;Avs+xs=lPcM40*oBnti2@dBZrI72R_5!GO5mFaw=D~woqrt# z$M<(;cX>*yvd&!Wof$puSG7P=qhc_<2uVjaL1I?EgBM3+1Qb%}^+QLU`%Mj@tf}VJ$T})33RE)Jg+elJztgP>&z|q< z?8sU7xj193)}hZ@VG*dX_$ag&b#RD`i%Qv?L>QQD-7)le@XwUm+H}c3zm99uo&@~r zidvsimSmJ$i0w4%=pm)-GFQsCDfJQ3;FM-}p~DxD{=aCIy32ED9H|zMf71%dzJhQ~qYI$RS_n|VSLbZhqdHE)GQPX)iS$()`FoMBWt-91k^<&(Ec%2%Ajb)AYkYR5h%54taN zJLzNSJiBsMhV*9EO^w2BDd8*4>Id#s&6j$Djk8%lO*myyNzS80p+ZC$jrtsDr7&NP z>p{C2B^^bp)|o+LNaCmCyJGSeCaXLhZoi*V2%RWpW|7;K82z$NtB|e2e@rytcNn*ZP|#W7u43bY@nK)#sW*L z>*oTP)>2hB2o8PDL8%SQN3Hvi@h0{cuZ_f#APm<_ttH_+%Sg|v{EH!*npa@EG!ep=k>DjbFSTi=;f z8_ceyMbq&n;U4nV@f}*TU2a^W^eOqwCH*nYMR926QeQ|4hp_UpLkdEA|QnVSCRoNHvWl!&>q8 znTdl2r}DHVpzI+sItmo~46DP!cCjY+uN%-*=CJNp7?61aKa^(meHLOe&< z$kfz#3->5M{zdRd-o`XwTuWPti(^F3E4uxd;4pek{s82;)AFNYSO6K-JY%MnWPuCbSNoq#o+w#BE z%l&6&=TW+~8{~ibkPx+JZPH}X3{`*w+8(@ChO5vrP&L!BT|>m2KJ-Nm>`PF(vV_4+ z+a^R!)7*!2u-ZMq*~z|~^4|f=;pSs3_Eqi&?Aq(2pBf~6TLxJeTY#1>xwFp%OF{%S zqg&dTDM}Pz^=Y-TlmbCiKgkNq>oY-SX4&1an)T8z>b3W9v9q_-mbVqoi)eXL)7djw z6!rAQjLB!!a3C!%%eKiC2?pt0!YpD5-%@X}jJK%LG`_K10cClX$pNfX;a%x`>6lpt zvv{K<-Z8(|J#U!ZCoc4>Uv*01@aHIbmI07j(5Nt^O305_GC7I2HnxsEcRI-R44z>R z4yOuJ?^EQ-nSU0(^F7~y5SX)o&ko0B^SEHs0*c)8TgP(G_edO~p*&Df$if?zZOlb- o;;F`}2P2-H^#7HPPbqX(ygUCSEr!s+_^<*j&27yHCf-T^1B~=`n*aa+ 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() {