From dc6b4ed47ceb266254e221fbd32ce7989e1ca132 Mon Sep 17 00:00:00 2001 From: Anadroid Date: Wed, 16 Sep 2020 09:41:35 +0200 Subject: [PATCH] Renaming templates --- .../bin/writers/BaseWriter.class | Bin 13223 -> 13165 bytes .../bin/writers/FieldWriter.class | Bin 3961 -> 3956 bytes .../bin/writers/FunctionWriter.class | Bin 2995 -> 2990 bytes .../bin/writers/MethodWriter.class | Bin 3282 -> 3275 bytes .../src/writers/BaseWriter.java | 8 +++-- .../src/writers/FieldWriter.java | 2 +- .../src/writers/FunctionWriter.java | 2 +- .../src/writers/MethodWriter.java | 4 +-- ...ntax.partial.html => field.syntax.partial} | 0 ...x.partial.html => function.syntax.partial} | 0 .../templates/method.parameter.partial.html | 1 - ...tax.partial.html => method.syntax.partial} | 0 java/libraries/io/src/processing/io/GPIO.java | 25 ++++++++------- java/libraries/io/src/processing/io/I2C.java | 16 +++++----- java/libraries/io/src/processing/io/LED.java | 11 ++++--- java/libraries/io/src/processing/io/PWM.java | 13 ++++---- java/libraries/io/src/processing/io/SPI.java | 13 ++++---- .../io/src/processing/io/SoftwareServo.java | 27 ++++++++++------ .../net/src/processing/net/Client.java | 26 +++++++-------- .../net/src/processing/net/Server.java | 6 ++-- .../serial/src/processing/serial/Serial.java | 30 +++++++++--------- 21 files changed, 100 insertions(+), 84 deletions(-) rename doclet/templates/{field.syntax.partial.html => field.syntax.partial} (100%) rename doclet/templates/{function.syntax.partial.html => function.syntax.partial} (100%) delete mode 100644 doclet/templates/method.parameter.partial.html rename doclet/templates/{method.syntax.partial.html => method.syntax.partial} (100%) diff --git a/doclet/ReferenceGenerator/bin/writers/BaseWriter.class b/doclet/ReferenceGenerator/bin/writers/BaseWriter.class index 56431fe03e68f53ca11f4ce559b76f34a029bb8c..8b027ec026ac60bcff86c203e21ee00134f61a02 100644 GIT binary patch delta 5289 zcmZ`62Y3`!bLQRN?Yq5~w&6&YU6Ta2L$2&zRT>qY41&aFD<8RKRNnh*SZb>I7m!2 z;Biz2reLZ8t(eAGx`7#JGRQOmFpIHl6A-g>?8Qgk z9`1u7IG*=Ag6T&}oFH+c#7VrG%-|@AQzRZO@fcoFoLcc%2Gb-~vOmZ9@OYfglo=9d zN}R=xpTL|G8Jxs`&b=9{7#qjF%$7KZ6{@2;))+7imBf=Jp2Fx{iSrCN2~XAWG>NAh zFpDERpGmb0>I|&MGuU2(0dujDX-$lsspA6vo@Ig?&(ZN*15QJw<9PVtnMF;Vbv5HDttOC(+@aUr9NBwoflTrTkniC6MbuQEYr(X09V$4Oiw@fsGn zR>$iMSVS9;(DjVnAkpUUjS_ES;>|kVV!#r-l^4xyeko(Ov7zYgyuQN+f8d=A?qbEe z8QddrnE`)d6@z;j+{dE#GkAbOiw`;zZj5K_K_4#1hZsD}{;l9xui$+i;RHK%vr@-L zeXtx?F<8y9evE2%8n){AxWqLq9OE#pmDr|ZyN>JZ9M{m)^$7Z@jdit$&1;bOggx6; zg-_bgxxUgmbbQKQsZGNTw%h#zK5cJtkHu%~p`P5Gnx7)ed@l*&E~_eWQ-gBOGo&Ee8;7ind9|&Gtp!MfwXmzNq6%wleP5UPhQ| zpP>a?KQ(G_{Capo$5#}-idz(Pz($3y;p;lSq3}(7OX1tF4I%x|y1J&uriQBei8W1g z>#7^mJot{pcNM;e?<@QOwn_ZZzD8xqXW&@{>+vJ|5tS2Nj~^>|4PIC925eEd6+cn< zDN2PGu);QlpYh^z{6fbs5yZ^?3ctdyC4NJ8VGDx0x~i$FOyRfq9fhr~zNYq+(`orV z{-EP_g+IbJ1z)q}pYUe|uQK)v{wnb|1aGKxhCMDNBky;7A3^pHhMb?mKk!ck3?YER zzi@|rR!YA1H-cqn=$1)`DD9`PlP&#&uOnpJ`PtbgD75hhg*$0K{MXSxk!+OG9|?D1 zTnU;X4jNkw&Sgu4$apFt5I8UR`Z|Q_a~;N~DVn z`?u7xv8KpWqKEM7qNfsB0+q;SgO=!}M2_gK!~r4~!92BUK~>qAP4iAKn>ufP&Gfq3 z8YN7TCq+JmT@=`J(+1A$BMQll+N$|A2%fsxr`F7AQn*kQNl{F(t*>ezPE$>T5+$4( z5hBlx-PA@-1Cg;m2c|C}!|88?g0EnU6s2}ndTz8I#t|~>8cr$WZYVqAn8}kSC$@oa zDPkg31n2-w=hV~TQbiEK*UfJQ-@zt?o_nc}IeSix6BQ*w@PvXL@V63S(O=iN{r%o z9>U;IFjN!|nbVW%7CUW;|?bt;yIZTt|o_Tf;qO zdD1mR4w|c~x*EY>I^N#a)8DG)7%tBQ&cac4kKBHEv^^qsjdlz|v7MKfYy0zp(N=hz zZdd^ptbrIHtaVmxv~KUVUI)d*qs}JyBuQk@mnt6Ifwh3E38CtzUVn-VG22gHW_ts! zHV|##TE!Buf&MgNJWayX*MvQ3Kb2Q*K1XyHU=PQ}Mz&$Q^803X7bmYB@q_ah7qPe> zw4G3{!{&cshz>6hqWujz8F(=%_(Oh077I$CHY+4P@m_+L9V0^vS_90>0WA&zaO*IL z1ax?XdJg`9sXM^ki^Qq_9r2!hf|)F?flxl8(*SblQ~Qk1X1W)|PRJ$;2N076lfzuo zr=bTk-QY3@W)OoK(_suN%+cRU;>M? z!Mt$^$c#7?uy-r>cy|!_Cc2=P4(}uK!Z}&u$Rmmihq9&Kr#zy!f!oq!P}dBe7I@jx+kxgtz=1L7-3;ya_L4x<3`Y#+ zH6TQMman5ixhhipDSovKMp-_8N_iyJGOW~gXhc{CO#l&NJxn`(EmTI*tTgk?Br68f zD=n{;7J~(q3sbNq{*+~yXT@MxGnkg)N-RdkU=-~p&9g0o6~dN`#^9W#U=ZeLdPp-n z%<)0sc+LeqPW_|rDznpcn4c`RosdJ+I81@meYg%`nj=fK`32YJ4j7#sr`G(Bsi;%9 zoXichU82Jh;r*mGo(>q)9~7baDY zC9@i-jtZFPJF0^N<^@hffCl59%sZ>Hm zkwKTyC8Q%@La?J5GU-I^FrJ8)()nEFtITdm*)guvd>tQ~9Ya^Pa1=}GLX_zjk44d^7gUe%Z1)*13 zS`4ltWHHgMW?G0swxF^F4AzRlHFiqikm$8BxUO=cn`&xfs12?Ut)inAzzjG6mJr5~ zDFaWOmYP#A+ns`01gOK3PVjU=ic@Mkx#b6SLht=m$&VC+@8Ku*fXtmm5%th_jN^h1 zwG${9H`s3lN|R^N=q&FC=`6uL$;{_b>gQpTIKazeX%rHO1euyIV)IddqX+V+bUb)b-S|dc2#)%o}{5-%gs}aw4M2o-fc3 zx3++s5TpuO4N;0S zM)2U>)o>k{J2?-3#9;t66u|kOzI3uY6?}-TgmWnA>C!yhOL6Tk)9WM2yKwx21S%8N*c}P zh)&6nBz2GdU^q9rjGoan{K@$YOIoTO?&UVBh{%OL3f>#*!D+RKcUSZc8uAqG1vJFX zde*#xu`78_U&YvBPU;m-gOMnOFKBt4iOm%~mZ}-yYI@{!Bx6Yr}jfH_k* z4#Pp|u$!X8KTdRMO4DyASAKvhJ`NEu{;yb~L#c5Uh=dRYDiOqgiAIk=aPdQEQ~&AF z`#3U|-ccc46<)vBFPA}4lR^y@@0C$m-lEUKFFO-J)G?9 zHHnZ}?Y+7k4i~_# zbX4fB3h9@AeHj#39>0CZz|34qpQQ9{?RGm|2B}!s1%J2@zrS|OtKiy!6JD}*lj|ZfQj2iIO z7~y*%jSxyXy=R?+^8dST^bm=esr2Q$TWBi?GLQb3VV-?gd0`pfQuL%q2QPZjNUDq= z1-@$ws9N`2(i4K_WA-oQe&^2j0saelPFuY|y1w1IBa^y)_R*!AeqyLYyASk`w)c&{ xmoXtG)7EqpF;Pqrlfa_?J^;!=qMr)8C;Ch2V>yc=2L>Ei;lQ&Uc##7a{|~?coG1VQ delta 5309 zcmZ`733ycHapvE*`~H3VXGvbzke2|tHjwO*K*SXmR8&B;Ne~ZGIjR97M95*Xc(m2^ zKrDjP_GvYst);eU(Fzn<6Va$usaOv@TCdhBwpLrU+Cvdzwli-R5{l(Z{x|>pGxN_q zfB5jC-WAEGhaMaNfD=TM0lP8BKtGN$;C{?yD9=C>^LZI<0$?FSmI;W3Iu=@ob6bNIaK!=dlJ0 zcxjUOb++exA1=g2j9DykiNtTP;TQ19g}gNLLVEARr3}qwTb4;&&I~O{9WOFq0p>_t zA#o*xtr9Ob;6hxb<7$a*1}tF@w==4PmresO!7i59ZNN%QFm4S)m+E*Ke=j$|jo;Mq zTL!Gc938)HKpRKa#49CUB{9j4yjtQlJ{U~0W^H(_#OoxkWrph|u4B{<62HTjte1GB z#0{+NMiV^j@=a{Q`4Yb?@n$CZo{rx)U>)5-L^eaWNW7K5KahAEBX8HS$AC?^nKxTl z{2dJ4=}VHNAM*Z3KKK;x;^oK8xRsZmNW9yC&u}R(Kjr0TOxnxK&w2TU55B;w$qWi0 zLEC(I58lhmFWJQV*xmQ>J=;0PWa$04L&u#y*oMF2WtRbE3-Eq+`feRl5+7iaKK4|< z#0PcUqvJz%p=+A|VFdl+?vD0Ztz8la>s{?p9Ursr(H7vZZQR!d%gOtj?d`$EW$Ze^>*5S|52bSZcoo>1@*zG-h$#mR^8PYPau7Ztn&`xU;0Z!0{2UWHe& zh<6nJnKysIcXj+Lf>>Om@I8EA;@{{d*pJ{|-kfNzRrq)Ofc)6e+0wpZHEln{k97Qp z!jIvAg7;YRC-_eV&olHd{I|saAb2BHi|koBc_p9X8wj!{9C3aWeuf7TFoFOIKgUCM zBBxaQ0>QHVx;2WFsH#>t$dbOqm+VJ##x1@TKTP|`s;i6qB zu`XJIpe0OR`S!>D+Bu^| zK#2k|Mi+%jSi+@55eqC9W0e>u#w$@GNW)CT)+Ab2*Ph$j*0Qjpy+w)9qD+c%^0=t5 zTSiSz21O;A(cawFg5c>`dU4CLgu-=V0{OJFxr@*oXEBjOGLANsA2mnt3?*8dSJ$je zw5=wOL`s#Y64eOC5t43>5%FRTyDmh)4EjAu!Czs&6k$w)drf!q3c6giws$9*+n2R8 zI=YC(-AY6RBII{;t*GUysy*|Zd5!ZjD#G8$+agy)N%_PTon%<9s6p_J@R@?Y165AJ zQS7rXU)JJyREb)6SV7z8a7c+sVzPpN!+(^h6UQkrMI5h0jH7dcn5x7y$`272)5*d( zSvXCE__i5JoXD{&5GN^dGA}d5DY`gSiPJb1vv`>;<|vdDa7dHYP+&Lb7mQKjbgB$7 zSDc~5nfL)q_!>f){erK|j^_E~Z`iVWIIwGG-jl-BAR2ec(Mvq}uIA;-DJYk5<<)m| zbRsm^myF4`AJIMb4PL)}iC$#;i~PH~ippJ{c^u$#?9Jn<@jUy9al5JWK&AcmxJrBL z_+avW*iExsfCVXdfb{BfcKx(}aKwHORMHuB5L$Wm=h2ty2;3p!*+~G^6!nxxNe~|g z=*!36kgE?wAGmff1w2N-8Xf$ah^bo;G+@szsWYD>ybEx&BV#Yiu-BJN%pXZkj&R5y zFWC@e@&IUqP^ZJbFJY<wVz1^b~aTfTtJkvGjhZKnOW&3dZ)p?RNKsP?GUo2yw$Q24X%} zOa)ZHw-qK?MnKiYbN0Z3^B;hwxZm=d-BwONB#`oYVUy*x{3%$|v{qqn`uT`?spT~< zOTpzNN19hy2Gc|>nSyU_2Eze})1Vbjn6 zImetjhy@PqUpT`K!f^+ol6^m%;TfO33kEks_8Hw5<)WZ(VaWVe3MzXbHw{!NSmRG))D=y^ zd~JCOW;RBm55m;|J3@4D)D_dAP{I3|j3C+bDawMrv5b90>!#d!GSUa% zkL(~-%U}_F12z%Fo~Z>-nzovg7auu!u?|p&O^3iU#Q8&gXpl>E${`s0RcZ1M^1%o2 zF6LSzO9sYR; zykB+czvxmLi*y;+FuPCD_q0$7ZmB1a-HOnIE&_glGzQi+M9ht;B;3{*F>g%4?Qtz? z_E7q5hC7)d?zY?+7PyI_3{Tu+d58;ci|Yh*5)g4#r~H=^%8?|^Xx!_H83BWRzIiK5 zbH#iC9~UoeCQvsqQn1C60bgnqY$4vwpqw3SvG;|GlXo=rraKNt+wF>Z0-mg(O3Tf? zh`60TkUL_V?FO%qHI|#Rpm*pH8FHt#d`9sW2!@JN@I$iN(cYx2pnm0La&7n+sIqM!yq`T~zs8#l3gnlUD z*Fk9?1SwDyG-|DJoq{2WYOB36IzIUmdQ4LbC*$)hX{mm=o69H`mur2Lf-mj?r_|!! z!``PRZjrm!PUyWZh?LwHw!BUk=Zv01*^ICe_E0`%Dk}-l z26{HFzZmYfX_x^@ha(sr1|9Fx#HXJxIrBr5@o9*I@qfuO6-tGxKxBx>Q5h!=5suz; z;NpkN4K)jsKV{EY`an#&V%~r^Ah*I8OAmPK;zpS5pltGz1@AdsVrMUe$%8*bXp9cT zG*`?Wa0j%lP!J8c>*Ahp#zPM2`y&eY>uhO=!%WkirVy2}^L(K!I*ZL1iRDIv^p8`i z=vWrAU2xxFl7sZ{bF4x^eeh>M_%fP(|dtp@;B9ylu=20Jkkfkwv7N^fId!YEp zHkpF^9);~Z{^Q5apCEaA21qQ|oF&c`^TEOZ?IWOL0sY_N7%V8KPm!~!bk?x5p5UxkIO|RS1sz4U Aga7~l diff --git a/doclet/ReferenceGenerator/bin/writers/FieldWriter.class b/doclet/ReferenceGenerator/bin/writers/FieldWriter.class index ae6acd59d0267cc13e4481e5672a07ea306f8682..4b2d06a46e10a1f2bc68f200fe876e6a3e546e4b 100644 GIT binary patch delta 33 ocmew<_eE|)CyR(kT4riaie7PLUP)qwUO{3}NoL~aMJ(630OY0(Q2+n{ delta 38 tcmew&_fu{|CyS(HT4riaie7PLUP)qwUO{3}NoHb>UPejo=D94_xd1E+4>$iwH@{*$$q4{NUk48W delta 23 fcmZ1{zFB<3Sw=>g$>$iwS@beWayLI=JjDqBW@QM9 diff --git a/doclet/ReferenceGenerator/bin/writers/MethodWriter.class b/doclet/ReferenceGenerator/bin/writers/MethodWriter.class index 89d58ba28e1fd2d5a96e023b64af254b78094b13..9e5f83b120ec54f071ee01940c212715da6d0999 100644 GIT binary patch delta 30 mcmca4d0KLV9TTJIWP2vj$&pMo>}tc}a4E9TTI}WP2u27QKv;+{wXAwVWJjrFqFEnfZB}uQPq&1OVOd45R=6 diff --git a/doclet/ReferenceGenerator/src/writers/BaseWriter.java b/doclet/ReferenceGenerator/src/writers/BaseWriter.java index 713effb40..f7ea85abe 100644 --- a/doclet/ReferenceGenerator/src/writers/BaseWriter.java +++ b/doclet/ReferenceGenerator/src/writers/BaseWriter.java @@ -272,7 +272,6 @@ public class BaseWriter { { TemplateWriter templateWriter = new TemplateWriter(); ArrayList> ret = new ArrayList>(); - for( MethodDoc methodDoc : doc.containingClass().methods() ) { @@ -286,13 +285,18 @@ public class BaseWriter { map.put("object", instanceName); ArrayList> parameters = new ArrayList>(); + String params=""; for( Parameter p : methodDoc.parameters() ) { + params = params + p.name() + ", "; HashMap paramMap = new HashMap(); paramMap.put("parameter", p.name()); parameters.add(paramMap); } - String params = templateWriter.writeLoop("method.parameter.partial.html", parameters, ", "); + + if(params.endsWith(", ")){ + params = params.substring(0, params.lastIndexOf(", ")); + } map.put("parameters", params); if( ! ret.contains(map) ) diff --git a/doclet/ReferenceGenerator/src/writers/FieldWriter.java b/doclet/ReferenceGenerator/src/writers/FieldWriter.java index 933470e74..f8dd7e32b 100644 --- a/doclet/ReferenceGenerator/src/writers/FieldWriter.java +++ b/doclet/ReferenceGenerator/src/writers/FieldWriter.java @@ -53,7 +53,7 @@ public class FieldWriter extends BaseWriter { } else { fieldJSON.put("classanchor", getLocalAnchor(doc.containingClass())); fieldJSON.put("parameters", getParentParam(doc)); - String syntax = templateWriter.writePartial("field.syntax.partial.html", getSyntax(doc)); + String syntax = templateWriter.writePartial("field.syntax.partial", getSyntax(doc)); ArrayList syntaxList = new ArrayList(); syntaxList.add(syntax); fieldJSON.put("syntax", syntaxList); diff --git a/doclet/ReferenceGenerator/src/writers/FunctionWriter.java b/doclet/ReferenceGenerator/src/writers/FunctionWriter.java index 47acf371d..6afe343c4 100644 --- a/doclet/ReferenceGenerator/src/writers/FunctionWriter.java +++ b/doclet/ReferenceGenerator/src/writers/FunctionWriter.java @@ -21,7 +21,7 @@ public class FunctionWriter extends BaseWriter { String anchor = getAnchor(doc); TemplateWriter templateWriter = new TemplateWriter(); - ArrayList syntax = templateWriter.writeLoopSyntax("function.syntax.partial.html", getSyntax(doc, "")); + ArrayList syntax = templateWriter.writeLoopSyntax("function.syntax.partial", getSyntax(doc, "")); JSONObject functionJSON = new JSONObject(); diff --git a/doclet/ReferenceGenerator/src/writers/MethodWriter.java b/doclet/ReferenceGenerator/src/writers/MethodWriter.java index a2d823215..52ae362d8 100644 --- a/doclet/ReferenceGenerator/src/writers/MethodWriter.java +++ b/doclet/ReferenceGenerator/src/writers/MethodWriter.java @@ -25,7 +25,7 @@ public class MethodWriter extends BaseWriter { String filename = getAnchor(doc); TemplateWriter templateWriter = new TemplateWriter(); - ArrayList syntax = templateWriter.writeLoopSyntax("method.syntax.partial.html", getSyntax(doc, getInstanceName(doc))); + ArrayList syntax = templateWriter.writeLoopSyntax("method.syntax.partial", getSyntax(doc, getInstanceName(doc))); JSONObject methodJSON = new JSONObject(); @@ -37,7 +37,7 @@ public class MethodWriter extends BaseWriter { try { - methodJSON.put("type", "function"); + methodJSON.put("type", "method"); methodJSON.put("name", getName(doc)); methodJSON.put("description", getWebDescriptionFromSource(doc)); methodJSON.put("brief", getWebBriefFromSource(doc)); diff --git a/doclet/templates/field.syntax.partial.html b/doclet/templates/field.syntax.partial similarity index 100% rename from doclet/templates/field.syntax.partial.html rename to doclet/templates/field.syntax.partial diff --git a/doclet/templates/function.syntax.partial.html b/doclet/templates/function.syntax.partial similarity index 100% rename from doclet/templates/function.syntax.partial.html rename to doclet/templates/function.syntax.partial diff --git a/doclet/templates/method.parameter.partial.html b/doclet/templates/method.parameter.partial.html deleted file mode 100644 index 4dfedff0e..000000000 --- a/doclet/templates/method.parameter.partial.html +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/doclet/templates/method.syntax.partial.html b/doclet/templates/method.syntax.partial similarity index 100% rename from doclet/templates/method.syntax.partial.html rename to doclet/templates/method.syntax.partial diff --git a/java/libraries/io/src/processing/io/GPIO.java b/java/libraries/io/src/processing/io/GPIO.java index bbfd57db9..6dbea0ad3 100644 --- a/java/libraries/io/src/processing/io/GPIO.java +++ b/java/libraries/io/src/processing/io/GPIO.java @@ -32,7 +32,10 @@ import java.util.Map; /** - * @webref + * The GPIO class reads and writes from General Purpose I/O pins + * + * @webref GPIO + * @webBrief The GPIO class reads and writes from General Purpose I/O pins */ public class GPIO { @@ -109,7 +112,7 @@ public class GPIO { * @see noInterrupts * @see interrupts * @see releaseInterrupt - * @webref + * @webref GPIO * @webBrief Calls a function when the value of an input pin changes */ public static void attachInterrupt(int pin, PApplet parent, String method, int mode) { @@ -190,7 +193,7 @@ public class GPIO { * @return GPIO.HIGH (1) or GPIO.LOW (0) * @see pinMode * @see digitalWrite - * @webref + * @webref GPIO * @webBrief Returns the value of an input pin */ public static int digitalRead(int pin) { @@ -231,7 +234,7 @@ public class GPIO { * @param value GPIO.HIGH (1) or GPIO.LOW (0) * @see pinMode * @see digitalRead - * @webref + * @webref GPIO * @webBrief Sets an output pin to be either high or low */ public static void digitalWrite(int pin, int value) { @@ -337,7 +340,7 @@ public class GPIO { * @see attachInterrupt * @see noInterrupts * @see releaseInterrupt - * @webref + * @webref GPIO * @webBrief Allows interrupts to happen */ public static void interrupts() { @@ -360,7 +363,7 @@ public class GPIO { * @see attachInterrupt * @see interrupts * @see releaseInterrupt - * @webref + * @webref GPIO * @webBrief Prevents interrupts from happpening */ public static void noInterrupts() { @@ -389,7 +392,7 @@ public class GPIO { * @see digitalRead * @see digitalWrite * @see releasePin - * @webref + * @webref GPIO * @webBrief Configures a pin to act either as input or output */ public static void pinMode(int pin, int mode) { @@ -469,7 +472,7 @@ public class GPIO { * @see attachInterrupt * @see noInterrupts * @see interrupts - * @webref + * @webref GPIO * @webBrief Stops listening for interrupts on an input pin */ public static void releaseInterrupt(int pin) { @@ -499,7 +502,7 @@ public class GPIO { * * @param pin GPIO pin * @see pinMode - * @webref + * @webref GPIO * @webBrief Gives ownership of a pin back to the operating system */ public static void releasePin(int pin) { @@ -536,7 +539,7 @@ public class GPIO { * wait indefinitely until the input pin has changed to the desired state. * @param pin GPIO pin * @param mode what to wait for: GPIO.CHANGE, GPIO.FALLING or GPIO.RISING - * @webref + * @webref GPIO * @webBrief Waits for the value of an input pin to change */ public static void waitFor(int pin, int mode) { @@ -558,7 +561,7 @@ public class GPIO { * * This function will throw a RuntimeException in case of a timeout. * @param timeout don't wait more than timeout milliseconds - * @webref + * @webref GPIO * @webBrief Waits for the value of an input pin to change */ public static void waitFor(int pin, int mode, int timeout) { diff --git a/java/libraries/io/src/processing/io/I2C.java b/java/libraries/io/src/processing/io/I2C.java index b977648fd..c65ecc5c9 100644 --- a/java/libraries/io/src/processing/io/I2C.java +++ b/java/libraries/io/src/processing/io/I2C.java @@ -53,7 +53,7 @@ import java.util.Arrays; * passing it as an argument to * beginTransmission(). * - * @webref + * @webref I2C * @webBrief Opens an I2C interface as master */ public class I2C { @@ -69,7 +69,7 @@ public class I2C { * Opens an I2C interface as master * @param dev interface name * @see list - * @webref + * @webref I2C */ public I2C(String dev) { NativeInterface.loadLibrary(); @@ -99,7 +99,7 @@ public class I2C { * @see write * @see read * @see endTransmission - * @webref + * @webref I2C * @webBrief Begins a transmission to an attached device */ public void beginTransmission(int slave) { @@ -123,7 +123,7 @@ public class I2C { * Note: It is possible to have two or more object using the same interface at a * time. * - * @webref + * @webref I2C * @webBrief Closes the I2C device. */ public void close() { @@ -154,7 +154,7 @@ public class I2C { * * @see beginTransmission * @see write - * @webref + * @webref I2C * @webBrief Ends the current transmissions. */ public void endTransmission() { @@ -183,7 +183,7 @@ public class I2C { /** * Lists all available I2C interfaces * @return String array - * @webref + * @webref I2C * @webBrief Lists all available I2C interfaces */ public static String[] list() { @@ -222,7 +222,7 @@ public class I2C { * @see beginTransmission * @see write * @see endTransmission - * @webref + * @webref I2C * @webBrief Read bytes from the attached device. */ public byte[] read(int len) { @@ -260,7 +260,7 @@ public class I2C { * @see beginTransmission * @see read * @see endTransmission - * @webref + * @webref I2C * @webBrief Add bytes to be written to the device. */ public void write(byte[] out) { diff --git a/java/libraries/io/src/processing/io/LED.java b/java/libraries/io/src/processing/io/LED.java index fe2d3cba5..e57863373 100644 --- a/java/libraries/io/src/processing/io/LED.java +++ b/java/libraries/io/src/processing/io/LED.java @@ -44,7 +44,7 @@ import java.util.Arrays; * /sys/class/leds. You can also try running Processing as root user using * "sudo", but this is generally not recommended. * - * @webref + * @webref LED * @webBrief Opens a LED device */ public class LED { @@ -59,7 +59,8 @@ public class LED { * Opens a LED device * @param dev device name * @see list - * @webref Opens a LED device + * @webref LED + * @webBrief Opens a LED device */ public LED(String dev) { NativeInterface.loadLibrary(); @@ -118,7 +119,7 @@ public class LED { /** * Sets the brightness * @param bright 0.0 (off) to 1.0 (maximum) - * @webref + * @webref LED * @webBrief Sets the brightness */ public void brightness(float bright) { @@ -145,7 +146,7 @@ public class LED { * Without calling this function the LED will remain in the current state even * after the sketch has been closed. * - * @webref + * @webref LED * @webBrief Restores the previous state */ public void close() { @@ -171,7 +172,7 @@ public class LED { /** * Lists all available LED devices * @return String array - * @webref + * @webref LED * @webBrief Lists all available LED devices */ public static String[] list() { diff --git a/java/libraries/io/src/processing/io/PWM.java b/java/libraries/io/src/processing/io/PWM.java index 2d758ec24..46b173ed6 100644 --- a/java/libraries/io/src/processing/io/PWM.java +++ b/java/libraries/io/src/processing/io/PWM.java @@ -35,7 +35,7 @@ import java.util.Arrays; /** * Opens a PWM channel * - * @webref + * @webref PWM * @webBrief Opens a PWM channel */ public class PWM { @@ -48,7 +48,8 @@ public class PWM { * Opens a PWM channel * @param channel PWM channel * @see list - * @webref Opens a PWM channel + * @webref PWM + * @webBrief Opens a PWM channel */ public PWM(String channel) { NativeInterface.loadLibrary(); @@ -94,7 +95,7 @@ public class PWM { /** * Disables the PWM output * - * @webref + * @webref PWM * @webBrief Disables the PWM output */ public void clear() { @@ -116,7 +117,7 @@ public class PWM { * Without calling this function the channel will remain in the current state * even after the sketch has been closed. * - * @webref + * @webref PWM * @webBrief Gives ownership of a channel back to the operating system */ public void close() { @@ -143,7 +144,7 @@ public class PWM { /** * Lists all available PWM channels * @return String array - * @webref + * @webref PWM * @webBrief Lists all available PWM channels */ public static String[] list() { @@ -182,7 +183,7 @@ public class PWM { * * @param period cycle period in Hz * @param duty duty cycle, 0.0 (always off) to 1.0 (always on) - * @webref + * @webref PWM * @webBrief Enables the PWM output */ public void set(int period, float duty) { diff --git a/java/libraries/io/src/processing/io/SPI.java b/java/libraries/io/src/processing/io/SPI.java index 6e447bfd6..1d987021f 100644 --- a/java/libraries/io/src/processing/io/SPI.java +++ b/java/libraries/io/src/processing/io/SPI.java @@ -53,7 +53,7 @@ import java.util.Map; * This library supports multiple SPI objects making use of the same SPI * interface. * - * @webref + * @webref SPI * @webBrief Opens an SPI interface as master */ public class SPI { @@ -95,7 +95,7 @@ public class SPI { * Opens an SPI interface as master * @param dev device name * @see list - * @webref + * @webref SPI * @webBrief Opens an SPI interface as master */ public SPI(String dev) { @@ -122,7 +122,7 @@ public class SPI { * Note: It is possible to have two or more objects using the same interface at * a time. * - * @webref + * @webref SPI * @webBrief Closes the SPI interface */ public void close() { @@ -147,7 +147,7 @@ public class SPI { /** * Lists all available SPI interfaces * @return String array - * @webref + * @webref SPI * @webBrief Lists all available SPI interfaces */ public static String[] list() { @@ -186,7 +186,7 @@ public class SPI { * @param mode SPI.MODE0 * to SPI.MODE3 - * @webref + * @webref SPI * @webBrief Configures the SPI interface */ public void settings(int maxSpeed, int dataOrder, int mode) { @@ -205,7 +205,8 @@ public class SPI { * * @param out bytes to send * @return bytes read in (array is the same length as out) - * @webref Transfers data over the SPI bus + * @webref SPI + * @webBrief Transfers data over the SPI bus */ public byte[] transfer(byte[] out) { if (NativeInterface.isSimulated()) { diff --git a/java/libraries/io/src/processing/io/SoftwareServo.java b/java/libraries/io/src/processing/io/SoftwareServo.java index cda338f82..df01fd8bf 100644 --- a/java/libraries/io/src/processing/io/SoftwareServo.java +++ b/java/libraries/io/src/processing/io/SoftwareServo.java @@ -35,7 +35,7 @@ import processing.core.*; * Connect the signal wire (typically colored yellow) to any available GPIO pin * and control the servo's angle as shown in the example sketch. * - * @webref + * @webref software_servo * @webBrief Opens an RC servo motor connected to a GPIO pin */ public class SoftwareServo { @@ -54,7 +54,7 @@ public class SoftwareServo { /** * Opens a servo motor * @param parent typically use "this" - * @webref + * @webref software_servo * @webBrief Opens a servo motor */ public SoftwareServo(PApplet parent) { @@ -64,8 +64,7 @@ public class SoftwareServo { /** * Closes a servo motor - * @webref - * @webBrief Closes a servo motor + * */ public void close() { detach(); @@ -92,7 +91,7 @@ public class SoftwareServo { * Servo class, should be compatible with most servo motors. * * @param pin GPIO pin - * @webref + * @webref software_servo * @webBrief Attaches a servo motor to a GPIO pin */ public void attach(int pin) { @@ -104,10 +103,18 @@ public class SoftwareServo { /** - * Attaches a servo motor to a GPIO pin using custom pulse widths + * Attaches a servo motor to a GPIO pin
+ *
+ * You must call this function before calling write(). Note that the servo motor + * will only be instructed to move after the first time write() is called.
+ *
+ * The optional parameters minPulse and maxPulse control the minimum and maximum + * pulse width durations. The default values, identical to those of Arduino's + * Servo class, should be compatible with most servo motors. + * * @param minPulse minimum pulse width in microseconds (default: 544, same as on Arduino) * @param maxPulse maximum pulse width in microseconds (default: 2400, same as on Arduino) - * @webref + * @webref software_servo */ public void attach(int pin, int minPulse, int maxPulse) { detach(); @@ -127,7 +134,7 @@ public class SoftwareServo { * * @param angle angle in degrees (controls speed and direction on * continuous-rotation servos) - * @webref + * @webref software_servo * @webBrief Moves a servo motor to a given orientation */ public void write(float angle) { @@ -165,7 +172,7 @@ public class SoftwareServo { /** * Returns whether a servo motor is attached to a pin * @return true if attached, false is not - * @webref + * @webref software_servo * @webBrief Returns whether a servo motor is attached to a pin */ public boolean attached() { @@ -179,7 +186,7 @@ public class SoftwareServo { * Calling this method will stop the servo from moving or trying to hold the * current orientation. * - * @webref + * @webref software_servo * @webBrief Detatches a servo motor from a GPIO pin */ public void detach() { diff --git a/java/libraries/net/src/processing/net/Client.java b/java/libraries/net/src/processing/net/Client.java index 023988bbf..9b241a32f 100644 --- a/java/libraries/net/src/processing/net/Client.java +++ b/java/libraries/net/src/processing/net/Client.java @@ -36,7 +36,7 @@ import java.net.*; * goes wrong with the connection, for example the host is not there or is * listening on a different port, an exception is thrown. * - * @webref net + * @webref client * @webBrief The client class is used to create client Objects which connect to a server to exchange data. * @instanceName client any variable of type Client * @usage Application @@ -150,7 +150,7 @@ public class Client implements Runnable { * Disconnects from the server. Use to shut the connection when you're * finished with the Client. * - * @webref client:client + * @webref client * @webBrief Disconnects from the server * @usage application */ @@ -306,7 +306,7 @@ public class Client implements Runnable { * Returns true if this client is still active and hasn't run * into any trouble. * - * @webref client:client + * @webref client * @webBrief Returns true if this client is still active * @usage application */ @@ -319,7 +319,7 @@ public class Client implements Runnable { * * Returns the IP address of the computer to which the Client is attached. * - * @webref client:client + * @webref client * @usage application * @webBrief Returns the IP address of the machine as a String */ @@ -336,7 +336,7 @@ public class Client implements Runnable { * Returns the number of bytes available. When any client has bytes * available from the server, it returns the number of bytes. * - * @webref client:client + * @webref client * @usage application * @webBrief Returns the number of bytes in the buffer waiting to be read */ @@ -351,7 +351,7 @@ public class Client implements Runnable { * * Empty the buffer, removes all the data stored there. * - * @webref client:client + * @webref client * @usage application * @webBrief Clears the buffer */ @@ -369,7 +369,7 @@ public class Client implements Runnable { * the buffer. Returns -1 if there is no byte, although this should be * avoided by first cheacking available() to see if any data is available. * - * @webref client:client + * @webref client * @usage application * @webBrief Returns a value from the buffer */ @@ -392,7 +392,7 @@ public class Client implements Runnable { * Returns the next byte in the buffer as a char. Returns -1 or * 0xffff if nothing is there. * - * @webref client:client + * @webref client * @usage application * @webBrief Returns the next byte in the buffer as a char */ @@ -420,7 +420,7 @@ public class Client implements Runnable { * a byte array on each read, but it's easier to use than * readBytes(byte b[]) (see below). * - * @webref client:client + * @webref client * @usage application * @webBrief Reads a group of bytes from the buffer. */ @@ -512,7 +512,7 @@ public class Client implements Runnable { * not large enough, -1 is returned and an error is printed to the message * area. If nothing is in the buffer, 0 is returned. * - * @webref client:client + * @webref client * @usage application * @webBrief Reads from the buffer of bytes up to and including a particular character * @param interesting character designated to mark the end of the data @@ -602,7 +602,7 @@ public class Client implements Runnable { * representation of your choice (i.e. UTF8 or two-byte Unicode data), and * send it as a byte array. * - * @webref client:client + * @webref client * @usage application * @webBrief Returns the buffer as a String */ @@ -624,7 +624,7 @@ public class Client implements Runnable { * String to a byte stream in the representation of your choice * (i.e. UTF8 or two-byte Unicode data), and send it as a byte array. * - * @webref client:client + * @webref client * @usage application * @webBrief Returns the buffer as a String up to and including a particular character * @param interesting character designated to mark the end of the data @@ -642,7 +642,7 @@ public class Client implements Runnable { * data to the specific client obtained from the Server available() * method. * - * @webref client:client + * @webref client * @usage application * @webBrief Writes bytes, chars, ints, bytes[], Strings * @param data data to write diff --git a/java/libraries/net/src/processing/net/Server.java b/java/libraries/net/src/processing/net/Server.java index 81f29a0a0..432d91643 100644 --- a/java/libraries/net/src/processing/net/Server.java +++ b/java/libraries/net/src/processing/net/Server.java @@ -41,7 +41,7 @@ import java.net.*; * commonly used so be sure to not select one of these. For example, web * servers usually use port 80 and POP mail uses port 110. * - * @webref net + * @webref server * @usage application * @webBrief The server class is used to create server objects which send * and receives data to and from its associated clients (other programs connected to it). @@ -117,7 +117,7 @@ public class Server implements Runnable { * * Disconnect a particular client. * - * @webref server:server + * @webref server * @webBrief Disconnect a particular client. * @param client the client to disconnect */ @@ -187,7 +187,7 @@ public class Server implements Runnable { * Returns true if this server is still active and hasn't run * into any trouble. * - * @webref server:server + * @webref server * @webBrief Return true if this server is still active. */ public boolean active() { diff --git a/java/libraries/serial/src/processing/serial/Serial.java b/java/libraries/serial/src/processing/serial/Serial.java index e2ff09437..d843963b7 100644 --- a/java/libraries/serial/src/processing/serial/Serial.java +++ b/java/libraries/serial/src/processing/serial/Serial.java @@ -188,7 +188,7 @@ public class Serial implements SerialPortEventListener { * Returns the number of bytes available. * * @generate Serial_available.xml - * @webref serial:serial + * @webref serial * @webBrief Returns the number of bytes available. * @usage web_application */ @@ -200,7 +200,7 @@ public class Serial implements SerialPortEventListener { /** * Sets the number of bytes to buffer before calling serialEvent() * @generate Serial_buffer.xml - * @webref serial:serial + * @webref serial * @webBrief Sets the number of bytes to buffer before calling serialEvent() * @usage web_application * @param size number of bytes to buffer @@ -214,7 +214,7 @@ public class Serial implements SerialPortEventListener { * Sets a specific byte to buffer until before calling serialEvent(). * * @generate Serial_bufferUntil.xml - * @webref serial:serial + * @webref serial * @webBrief Sets a specific byte to buffer until before calling serialEvent(). * @usage web_application * @param inByte the value to buffer until @@ -229,7 +229,7 @@ public class Serial implements SerialPortEventListener { * Empty the buffer, removes all the data stored there. * * @generate Serial_clear.xml - * @webref serial:serial + * @webref serial * @webBrief Empty the buffer, removes all the data stored there. * @usage web_application */ @@ -272,7 +272,7 @@ public class Serial implements SerialPortEventListener { * Same as read() but returns the very last value received * and clears the buffer. Useful when you just want the most * recent value sent over the port. - * @webref serial:serial + * @webref serial * @webBrief Returns last byte received or -1 if there is none available. * @usage web_application */ @@ -294,7 +294,7 @@ public class Serial implements SerialPortEventListener { * Returns the last byte received as a char or -1 if there is none available. * * @generate Serial_lastChar.xml - * @webref serial:serial + * @webref serial * @webBrief Returns the last byte received as a char or -1 if there is none available. * @usage web_application */ @@ -325,7 +325,7 @@ public class Serial implements SerialPortEventListener { * available() to see if data is available. * * @generate Serial_read.xml - * @webref serial:serial + * @webref serial * @webBrief Returns a number between 0 and 255 for the next byte that's waiting in the buffer. * @usage web_application */ @@ -353,7 +353,7 @@ public class Serial implements SerialPortEventListener { * an int value for the number of bytes read. If more bytes are available than can fit into the * byteBuffer, only those that fit are read. * @generate Serial_readBytes.xml - * @webref serial:serial + * @webref serial * @webBrief Reads a group of bytes from the buffer or null if there are none available. * @usage web_application */ @@ -445,7 +445,7 @@ public class Serial implements SerialPortEventListener { * area. If nothing is in the buffer, 0 is returned. * * @generate Serial_readBytesUntil.xml - * @webref serial:serial + * @webref serial * @webBrief Reads from the port into a buffer of bytes up to and including a particular character. * @usage web_application * @param inByte character designated to mark the end of the data @@ -531,7 +531,7 @@ public class Serial implements SerialPortEventListener { * if nothing is there. * * @generate Serial_readChar.xml - * @webref serial:serial + * @webref serial * @webBrief Returns the next byte in the buffer as a char. * @usage web_application */ @@ -547,7 +547,7 @@ public class Serial implements SerialPortEventListener { * two-byte Unicode data), and send it as a byte array. * * @generate Serial_readString.xml - * @webref serial:serial + * @webref serial * @webBrief Returns all the data from the buffer as a String or null if there is nothing available. * @usage web_application */ @@ -569,7 +569,7 @@ public class Serial implements SerialPortEventListener { * String to a byte stream in the representation of your choice * (i.e. UTF8 or two-byte Unicode data), and send it as a byte array. * - * @webref serial:serial + * @webref serial * @webBrief Combination of readBytesUntil() and readString(). * @usage web_application * @param inByte character designated to mark the end of the data @@ -593,7 +593,7 @@ public class Serial implements SerialPortEventListener { * connection open and it's necessary to distinguish between the two. * * @generate serialEvent.xml - * @webref serial:events + * @webref serial_event * @webBrief Called when data is available. * @usage web_application * @param event the port where new data is available @@ -678,7 +678,7 @@ public class Serial implements SerialPortEventListener { * Stops data communication on this port. Use to shut the connection when you're finished with the Serial. * * @generate Serial_stop.xml - * @webref serial:serial + * @webref serial * @webBrief Stops data communication on this port. * @usage web_application */ @@ -736,7 +736,7 @@ public class Serial implements SerialPortEventListener { * String to a byte stream in the representation of your choice * (i.e. UTF8 or two-byte Unicode data), and send it as a byte array. * - * @webref serial:serial + * @webref serial * @webBrief Writes bytes, chars, ints, bytes[], Strings to the serial port * @usage web_application * @param src data to write