From a31409f7bbe7db51f63c79b16358d64ae6e2d4bb Mon Sep 17 00:00:00 2001 From: Matthias Melcher Date: Sun, 5 Nov 2023 16:12:15 +0100 Subject: [PATCH] FLUID: Documentation --- fluid/custom_widgets.cxx | 2 +- fluid/documentation/src-dev/fluid-128.png | Bin 0 -> 10179 bytes .../src-dev/page_introduction.dox | 60 +++++++++++++++++- fluid/fluid.cxx | 8 +-- 4 files changed, 64 insertions(+), 6 deletions(-) create mode 100644 fluid/documentation/src-dev/fluid-128.png diff --git a/fluid/custom_widgets.cxx b/fluid/custom_widgets.cxx index e254f19d4..99cfbbbdf 100644 --- a/fluid/custom_widgets.cxx +++ b/fluid/custom_widgets.cxx @@ -157,7 +157,7 @@ void Fluid_Coord_Input::callback_handler(void *v) { } /** - Get the value of a variable. + \brief Get the value of a variable. Collects all consecutive ASCII letters into a variable name, scans the Variable list for that name, and then calls the corresponding callback from the Variable array. diff --git a/fluid/documentation/src-dev/fluid-128.png b/fluid/documentation/src-dev/fluid-128.png new file mode 100644 index 0000000000000000000000000000000000000000..cf9cf406e17201dbf7ea5edef85fb910e248f539 GIT binary patch literal 10179 zcmV;!Cp_4RP)bGO{hZn6nUAdvGs z_u1XMbLY;SIp@qdXJ*cUas&YgMNx$M{nJ2&bVXFKu+5u-Ny}XbAprg?X$$@qJ^+j? zX$$o3FR3d5aFw(Lx$d{yrU?ODQql@seqD$z(bK7^slLw(tJNw>G=y$w`HV2VnK)Lf*sM8UEK6Srk>Fz$D z=wSa!nAI!L%Mm0CAq0Z)If91|ie?k$iS36I<-KH=*mWd9@X&rivKJqU&%*!=F^uB# zac`nbDu9ebkdcOX?+S09lU?BML9*ghfPo~7#UB1Sx*44LP`w3Yp9Gf!j_-i*YO)J8 zF7Z|X7=SjOU#Aa1jaJ@H+2iGBR3hgDgifdPl?NpQi^bwgJSDH7L4yV%k#JCX;B-2r zP?%iwi-K0rrcIlWS{k&1OD>V}!#T0&3X~!^Qd>|Gj}l4?`nezOJqzNV_0$*|_J-1*D51?gGBo zz}X8#k9WTp+_%khk7Oa3=nz^Y_DcO6VDr&tC=>HhuA2|Q;+u!FVt-GtM5Byak235d z^(j5R0>vXt#3ThJMZnQbka-vkVG!RAgbR*s15>z^6CQ*pD4+Y%;~tq(RPmvluep^!_tw{_(g5^*R$j@9046BvyN;s?o~us zF+&iF^Y*jyYV7?*X~!k?td@yt-r&W;TJWk>t4h>}P=`Q_A3wg(%_xgk7Pz5n*RF12 zbd^=lUBUbTZtJLsq4@M{*{~b1G88Xa?^%$Z2Y(y}F)4JmEN%!iFSksU)9{&s!Ucaz zD}3+UZ@(>8-z?HHvR^ighhOyCnDaJ+)d;pQ=utOBy-j-d9DuPT4R8WFud03)W|^vf z10Mr7hcW~MeP1pnDSS4t2S-OoOG_x{bYOH%QsCrX&+j+;-X`yzIp#LYZVHtK7Q0_= z5@-15cr-)j&gYd?w=i#28|gd@gvtlDYleG&W_>p7t_?=3O3vd$vOfgZe`OoE2?~ThAanlcpt%s82?;$e<6P+HXt=a$)3jqc;%)tTG2|fB zz&-vAn6G^~pe|cri)YpC-MQTjz)QD$$J-|EP zbOKjF;DPS{s;7t2TRq?{Xm_`!_fPd4!`mNKV^7UT!I=vO)CIZBLvmFsDhW>h4YfPL zznejCl-T;`SBPs4Cw4;Zj?%*&oHd0K$Q2_dNyI33{{{)|%1;|fRsxx33d-1H;K+ko zwJO9q&JQLgD*&2O1?3MD-Co{OTrR*`*%7c4bz@0RPL2o_d={Q3m1pA&6@Y-vKqHgM zgxPGyFc~hbA^-UEh*xDQJPij}*Q)#``t9vQvN=plQ=mtKEAlGXhL*3J41e zD;e2%WyTRIDg5Z3%QG`GMQLErph3R+z)h8@^8yfdyS>N`uG}Ytk}O28nIS7hj`N)b z*1PBZ+}vE!)6;_%v`?2STy1Jer*gZu;JIIe+Xcgi4+pv3U6iGTsFYDX5kRI}+UMmJ zZ@-)=fQV_(G!~BMz^NQ?6tinKD=Q0|&E~5i8qNoD-{mIJ?Cfk&R&ePXLPSiH=Mwzc zqjBTLzHDJVmlPlX3GUOPZUWF1?r4bVF*|T z^a5D3W(^%WbO>0;Z(Ah;n}lWvx!EJa1X=m8@H!Y8M3HRWx-}a%Y$$bqO21>K=4Ej2 z`eFiFdb|89oYJ-bFTfXMQg1-|!m{`Q}>op-tDRp)E|*XC)+J}y1@j$Ft;!|9BF zIdr;&vzMbl*5M4|*>^f1Kb!j2jkL6{ftW^e$swj8fL(28&9Xv3v|8bnn4{#25<9!+ zCr*uxLZs;V@%ucw#4jahN&?}BmLO6sh^Y~r*|iSxL*L8Qr_NW1R1-PLQE=#Y$j|Yg z6VVr(MobN7_oJ7xdCg(9egXg61>Rk_XxxkqRP6uaF69DKp;Q@%L4`FsMHygs_AUzWY*~i1w!3z&&ROyP);RVnf zy-8N++j$`%FOz#Z%mm<_rM*FKf`V)sMsCNX&nK_Iz`=q`!4{9P;5cHk5s_+!U0*@= zG15lIBPJW^YZwP7c7P+FF4ez8Og51Sd2c40h?i(Vf!Rud#$U2Pg`3%RO zsKwuDakO~+9jM)r(=T)bpxzzR)cS3~Wx1Og650b?L4XxvUj#H%3-rWbmJgaDg7|n` zyglT80D4V&0wQaJK8$Od&Xs(#zb3+-gf2Xq7~>IaVOeD6gt6klmE7KQIUfwWS9bK; zmmszQ7_D4cS1#&q+8d9sCt5!XFYHztf(5hY<5ylK0XR`QhzoaIy=s!Hu zXAHk?t?ed2Oa>?9Wyr&ap+M~pa!_kt2GBx9M6`ljx=H~Bl7qY8n?!GAaHIJ=v+{rB zPN_+lAzyCouG3i^2}Q~VN3Lv?K1{9|D~jCQ?#z?I&JZTcIaSuuhe;k5LaxZV3Zy*I ztBRd7UtT(cyytSr=}~V2gRyj~OhFDzwU*2!cHmeHcaM0RyW6}?!?APtC!;phZ3LER z?;dqU3B1+ZV3L`*4Ost(`ZQn=iy7Rqffk7vi!yCuSRpFAT&6OSj>->&A zMwl*OMJN<&EGr+<($X#-1RNeCPu=b~AwL&hSJ;xgpoL(#vGA#p>5E(yX0D&_#*nxu z5s;gkd-2GC63WO*2g_74E|EWQ?b@}zKEV!^we$D7I}s=dX>njM7%IJISODU(%PuR` zPEm)$QK{YI&eD*+KV)WR`XXRlW$C=)yS)FA{p5?^5=5 z;5~rh!-q3}{`}w?*krg&-O6}62kOTJc98=ZjYeNTp>jSWKmfFF-=4K=*A`i@*{cxl zvuVUP2u(3Qf;0r4FY~gjsCK6gs9B+o$XyZ4>uN#I3N9BO=&2hGzf6HpL1u52n5M1plvO! zqLbXC?4|H`^WW#!*Y0rt97YL4OO_M?KYH}>Co_X@r&mF*g9cHs`!qPqGZe~Gv5Gusr3UG|mLi-k*m<&?I}h;q3E#2YUtY6-JOya5xa0GAC8@~fe{G+o zbM^bGnh*rlq$#x{G7V2UYDQF@P@M?FH1i2kY>Nlrm{wW zcMQjC&mJXr8BalSI4^&G1wW7K&w)o9Bc@mpQ>@G%HUu*M3H?xm5Qr2#VycyD*+0tz z5q?zlSf^{;T<;x;c$Wy{D2g zf4C>o|DdNH#U*65W8NO99*j^zMu10tWbT#6;r!U=nV%mcD^DJF82kQUiCp)wnX8_M z#4hfllS8o=ibFszpfLa~u7mJ64Zm->Umj^mo-+_^HBrVKW<%~Ebc$^Cy1h*yEYh8D zCj^nKpo~3^a_4G}(pt(H{}$?W*v;}B;@n?4gE>;3MDchee)2{5y0bw*gzD9m$5XDI zryZ$+JgSACP=$a=Hr5i0EiTGi&Kxa6Dhii84O);RkHrWf`PPvyFZae!;R0hgRBHxt zO~K?o5hgsRNv*D<-ulBL<(Wa95~BW&L!_E`y7OI}PL>;tmThPZ)>tW&{aMT$4ejoA|LP2UUQz@s^VB--Orbw-n*Slw zm;M)kHmg4FhWo&0qQxA!Jq4=U)wZ8R&%1CaClS;BsJ| z$B!vVh6Ty=`BoVeB5hTi=3gVr8IMw`O^uxg6=DtXfmuFgo0Bx$A|Jskn&7%*BfD&F@Bb1ax68QtYI03Lkj2C!BGy@?J9 z(que*(k`Dhn0aIHg8*EeJQ^Ysu|@byiRLJYyyEr~jnhoqi;6>lcfu|zHh}Qi#T90g zf=hwtu6j())$b1lt0d3VUdaHw|6L~tkE3;M?PFK# z$GErsI{>WQ*ihy5Fi)8Y9}h-nv4wtg@4ETEEcRs}1pFT$16^MGDby+2s{CIkNx~^} z2grkyI+KPfjA1%%X!9lHp7!v6u83fNY9CU+x)Xqxzv#}pcfBk_BNuoDt;wusV2h;` zvMwMMX-f=@JyE>6nyf}X9`XUy z?IDGr%OR&VV9m~kbeb^-B9jo$*6j<3qTOO&6t}l5!`xu1>uq%&>5ukj;iZD zB&{g&Sxbzp%Md1?wZ+SOLda(oMODXr%9PmSy3ifi8=#jLeMKEeb~(7M^+)`<*+%!4 zJITs5^ZCZU5U-v4(HlS?QAl?$6k%K!R``8-L*dcX=?g!rFN=L$ibo9SLVe)rWp^{> z+L@%Cv|}6ft<=@6)hh2HYE`NAq9VB%r$v4?-s5q17|s-Oz0pb9GgPFz11 zZbP6AaEbaEuiCf~XIZyfMan_0JFP}0uUcM3LgyB)LIw;xm-A_AWk#T(k`urt-3^yNsMPAAF}0!V;KRTALbLXy_?r1kEs+7EXwmZy@fM#wIZTdp3x z0v;|woNIu?hYttJIqs+;fO89)@X9Xl52_Q|R#;M{^n2`kUgTR}ql=&A_d+=6Dr z%QN&?kdQ`>DgwAjBtQ@)&`?DHRT7{|39QT#VAX!;H4EaxAwI&J9wjXcj%2}=^`$a- zAxZ#4l?0Fht}m;h-QcGv(peNAAy4h5tb_)EiK|KnILBc3{SgxrQ*JK`k}@{8iU7_n zXfmwUty{Om6(o0uKaWW7pxe?DLjL~qi1a6nxdJjX1G*J=R!srt7L*Wd^&(+HcX_Sa zuU#96Fu}d;yeo!^av^P?x^M`<6@sQ75)>EYz9M5gS4{z-gJwlPGBUETD3GCLb zTd-qBRhvUA2wDO8{)5o9Ygdt*n=8s291e#_O-&7!1@ZH$;VEAj>yLD!(J0ogT`MXY z4jw!xTDEK%hzNcrNK}?8I6INQ&mY+l5fS2_fBq5Y62^=f6Nm^Lz`#o9L^)4Qyt&9= zklscs3iIa8qAgHOjf8YO2aab$=Q{A+EhXD7zIX3l+O}=WsZ*!? z|4Ij10EemwpybdR846V+PP=sJ!qTNnLptFT2p;{`|$R1U>}3;D2-U z=+Qj?{PX7(m4>=)EEw$Gy_>;<2eW0%7XQD#Kt^=Es0g5)>M+r0a~(T&9MvNH2C!c)cf7_`N!IFzX3493n&3Ev1IvsDl^;XD(f2KfY z*f69*?dPG%EArEj3ij#J&OdJzow;-Q;fEivSTv@H9vR0qTb&XwNC{vCwjjf^dd;qC z)!4anC(+TNucg?hLv6b}>*o*I1+eY7)b=0gRCbL|T`7-~*Ng}}1=vjTEMiG~2MZT2 z3}h`7AS0dscA*e}6_}%%K^mAndp0-UT=EQ1{<(SlVaqXiyi4g#x#DzzqPC5d6xOd_ zPsffO1MM|P0g@{_0ki`Cz;D+MiCy8=ABv7pTMU>D&^ShBsPeFmQ)a8lt!x{$T?Oz_ zf7r7$kZy1#;%!&x6?oh0Nfo2sP}H`& zH?%Ii88&?!paOaUE6!&ESO^R)^opClf<{*tAp)J;(0mThUiCN$_B1|PH;{&L`{`7F zBj0W7!nE&4Q9UY?#F(ShkKIp`xW8#xb33utlT;hGfedGL8CbluQPhhR&o0JyP35t! zGdP(Y#eEA>`D%M#8Rp(-mErM=+Ab~x&-8he>fuMI6>*q4_Jh=oIe^6|lNdBj{hA%8 zTFTrbMynbSU4h(F@IqZRg_Z_>1KOW&1W;cc{L3_VtG9&PSIIE?L6CcMs}Gqy{67F3 zIvGp-(eINltmJ=iwI@x^__;Um^7n%{`qoG+CaoaW%%l2O-Lx-!`ae@+o%LUGS$jjij2YS;k(dz~NU|AP#f9Da1tP{Mh zxr1THV*grmfG)@dv$KM-I2Ujq@M@vEJtsr=2}N@KQ@tN&Y_}PnTm4eTke{!BJqqi? zo4BIxI`*d7IQVZQ-I{LF4E~7>E7Rs(2{wbw&!9J{dDO~Qs6D-MG*;yVqr1LE`WXuk zzJCkLHnoxm(n8sQs?z~RF0Z#uGx$Ql;~xx>62xd#b4(Zt6Viw;;NY+DK@V_w`fpK{ z>pxM`xtouNRA1&{|Ew4TxQ?NuP$$T`5UM9$M z6|nrSLG)99+}nGe)(4lTL}hp&(eWu|G>Tb=M4jZoYv@bFYy^Zi$ttw*qm$KlGjo^?JeV zzN(@O$lb`tkQr`!mp1`eRhv|+gftlpBZ}GY;DVLAJF#+GO9nMqK+QhhfJ?vctj*o8 z+$fO|9w$?Bn6uQhJ4R1VGB=EQf0)c!Vu=M)1a@-hi%cemAeMTbr} z`1+Os^lRjG;B+59j#azbKzKCRtAkA&RN_R2m1hHIp14i!DRR3t(wwTJ2$@kMR$Hb&=R8Jz!Ht#sAs`V+V$GU-XB7)5-kV9Lv(r! zN&zWXKBX-?bGR&{5?z!zo!yVLAjaz52zup&hgr4rQixQO3z=+88~Bi>o+oAv!4(!I zv!9wH)nsC&T$3|J$ONa}EJ$t`fQ(xZgIr(=&X>i!;(lPGX7F`JxNEI6?@H>*6)qm^ z^r|2Ccf+NRkjOAaNCivLfpC%1Gnt66EFVSjayA@nq9QK}jAl@DbWd8&H7&dupN^-8 z^YBb{O0iZ0qm{+CUQfLJh^NesgVlNM+kWzYORVH7odFPx?eYwfX0QGI;j;E@KHNy1 znj+B|bZq)xJI&xvp3|SDTiZwpW{U@NB)7Ji$DrolcpZId)p%!VA4zcLXfOAlt>tpt zGPvP$|9ZlZ2Uo8t4FL>ODd?3#6!*~H(z$Ylz-~Orf7;I0+7Rnh%?8?0aNtga`M8}k80{1`QmLjO{zW-W@Fi1*U-Po51KNg-yJUB z>E?c&2~e==GMUixDb0Jw&KeG3QL4geNxAe(H>6mw2w}5O^{J;+p$gd7mLqQne110Ny}u%Jj0gP7gOOfhRMI zcI6hs{r7ix-IHP*;DaAJax}Z9nhn>cN)#R7VqEuWp46iNZ+_i{!XkH) z-3$e1=vQ|!t>ZU(%6<0BrF^xaJ(#0unV81$loq_RN~^m3vb7%HY-o!)+|199-a+;7 zqcY#SBaewaCKG1xrW$>1NjHvU)g&&~!GS5gX&SSMjRZ0C5iY$&5~a~X$J%RI zaYtXx*lyWhllf~p&?M;;D<8dEYVpo|siTzDfmTxl+_yza1f6DfH>y5^c}4jFIs;1q zZCc)zH^A_@XX{7@M*(S%B~r_F)Wccvx6R;)v#GS@ZSiVKWF5F192%3T5!uT&G{GF^ zB+C&+|JUEZWw3)Oobgw_Lh4mdd&=!P6vvW3+Ay;BFD&?@4|mU*$oQ+@CUvk^QT=OA z0tZjT(lqfn?WTQ1x+`Al6Gk(K$2Fy@& z)ts$I8gWaP(WZ^>3-eWbWcGqlN z=4xOu@!FcZ>D6pK-5UPJsWaiM`MWU_=8fQ3ev;JIt>Kb;^+x)=w}6?$?&Xq%?HoB3 z#oE6clluAfy2eU_#g@FfgLg%=G;NP|3m{vflqlvj}67M2e82v>;n8n=gsTVD`FL6+H-t*PG{ZN)c(aXv-*y`rce9$dd05_Fmxx zN1n`nU63uGQ*^Q}gGH7TF4=ZRj@KMDTIGB7s?({W;tqY-5B7ZTe|LhRuqmjNe(+sR zw%pf>=GEnOq7FePmmhD-mG24Qxu7Gy+Lw{X4#a& zNYhy);?2=`){q00HHLfLv+gqfb?J@r3XAZTbuZUy%Iah}Q=mG1W>*nH`zr!&{mwUU zw5PXa7$iz^{vU@f@esh8^>%J-@-83U{w$}nBe>>;@vPX|3L+z=XU?j+L4!6!MP?`n z3pALeDO1w2#g!|`JIfuUg6%tK3Nq_fiU#S)u2L_b;>d%%beU>8KTC>1ok3o1jxpI) zyStp`zbXg}FVuzf{Tc!Y;Dr#d^)qNbv=juU1Cv>%*0#jRdC#-rrj!5c3;}lcR6)7J zvT^={50I?@3CQi*kwuFRpLwp(lB#<