From 779b3d1bfddae903dfd481aa1aa2f740bb995018 Mon Sep 17 00:00:00 2001 From: Jens Noack Date: Fri, 9 Jul 2021 15:30:20 +0200 Subject: [PATCH] Add logo --- Bilder/coderace_logo.JPG | Bin 0 -> 20511 bytes .../lib/CodeRacer => CodeRacer}/CodeRacer.cpp | 0 .../lib/CodeRacer => CodeRacer}/CodeRacer.h | 0 .../SimpleBTCoderacer/SimpleBTCoderacer.ino | 0 .../esp32_coderacer_beispiel.ino | 0 .../CodeRacer_MKII => CodeRacer}/keywords.txt | 0 .../CodeRacer_MKII.cpp | 0 .../CodeRacer_MKII.h | 0 .../Webserver.cpp | 0 .../Webserver.h | 0 .../SimpleBTCoderacer/SimpleBTCoderacer.ino | 0 .../coderacer_mkII_beispiel.ino | 0 .../CodeRacer => CodeRacer_MKII}/keywords.txt | 0 CodeRacer_MKII/library.json | 22 + doxygen/.gitignore | 3 + doxygen/Doxyfile | 2492 +++++++++++++++++ doxygen/Doxyfile-mcss | 10 + vsode/coderacer_mkII/.gitignore | 5 - vsode/coderacer_mkII/.travis.yml | 67 - vsode/coderacer_mkII/.vscode/extensions.json | 7 - vsode/coderacer_mkII/include/README | 39 - vsode/coderacer_mkII/lib/README | 46 - vsode/coderacer_mkII/platformio.ini | 17 - .../src/CodeRacer_Example_Main.cpp | 223 -- vsode/coderacer_mkII/src/coderacer_main.cpp | 250 -- vsode/coderacer_mkII/test/README | 11 - vsode/esp32_coderacer/.gitignore | 5 - vsode/esp32_coderacer/.travis.yml | 67 - vsode/esp32_coderacer/.vscode/extensions.json | 7 - vsode/esp32_coderacer/include/README | 39 - vsode/esp32_coderacer/lib/README | 46 - vsode/esp32_coderacer/platformio.ini | 15 - vsode/esp32_coderacer/src/esp32_coderacer.cpp | 128 - vsode/esp32_coderacer/test/README | 11 - 34 files changed, 2527 insertions(+), 983 deletions(-) create mode 100644 Bilder/coderace_logo.JPG rename {vsode/esp32_coderacer/lib/CodeRacer => CodeRacer}/CodeRacer.cpp (100%) rename {vsode/esp32_coderacer/lib/CodeRacer => CodeRacer}/CodeRacer.h (100%) rename {vsode/coderacer_mkII/lib/CodeRacer_MKII => CodeRacer}/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino (100%) rename {vsode/esp32_coderacer/lib/CodeRacer => CodeRacer}/examples/esp32_coderacer_beispiel/esp32_coderacer_beispiel.ino (100%) rename {vsode/coderacer_mkII/lib/CodeRacer_MKII => CodeRacer}/keywords.txt (100%) rename {vsode/coderacer_mkII/lib/CodeRacer_MKII => CodeRacer_MKII}/CodeRacer_MKII.cpp (100%) rename {vsode/coderacer_mkII/lib/CodeRacer_MKII => CodeRacer_MKII}/CodeRacer_MKII.h (100%) rename {vsode/coderacer_mkII/lib/CodeRacer_MKII => CodeRacer_MKII}/Webserver.cpp (100%) rename {vsode/coderacer_mkII/lib/CodeRacer_MKII => CodeRacer_MKII}/Webserver.h (100%) rename {vsode/esp32_coderacer/lib/CodeRacer => CodeRacer_MKII}/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino (100%) rename {vsode/coderacer_mkII/lib/CodeRacer_MKII => CodeRacer_MKII}/examples/coderacer_mkII_beispiel/coderacer_mkII_beispiel.ino (100%) rename {vsode/esp32_coderacer/lib/CodeRacer => CodeRacer_MKII}/keywords.txt (100%) create mode 100644 CodeRacer_MKII/library.json create mode 100644 doxygen/.gitignore create mode 100644 doxygen/Doxyfile create mode 100644 doxygen/Doxyfile-mcss delete mode 100644 vsode/coderacer_mkII/.gitignore delete mode 100644 vsode/coderacer_mkII/.travis.yml delete mode 100644 vsode/coderacer_mkII/.vscode/extensions.json delete mode 100644 vsode/coderacer_mkII/include/README delete mode 100644 vsode/coderacer_mkII/lib/README delete mode 100644 vsode/coderacer_mkII/platformio.ini delete mode 100644 vsode/coderacer_mkII/src/CodeRacer_Example_Main.cpp delete mode 100644 vsode/coderacer_mkII/src/coderacer_main.cpp delete mode 100644 vsode/coderacer_mkII/test/README delete mode 100644 vsode/esp32_coderacer/.gitignore delete mode 100644 vsode/esp32_coderacer/.travis.yml delete mode 100644 vsode/esp32_coderacer/.vscode/extensions.json delete mode 100644 vsode/esp32_coderacer/include/README delete mode 100644 vsode/esp32_coderacer/lib/README delete mode 100644 vsode/esp32_coderacer/platformio.ini delete mode 100644 vsode/esp32_coderacer/src/esp32_coderacer.cpp delete mode 100644 vsode/esp32_coderacer/test/README diff --git a/Bilder/coderace_logo.JPG b/Bilder/coderace_logo.JPG new file mode 100644 index 0000000000000000000000000000000000000000..0b58ee11a77acf338c986899a94565f7ee29e428 GIT binary patch literal 20511 zcmeHv2UJsC*XBh~5EMiyf=Colnt)UhfrtnSh=_`zBho|!r1u0wKm6VN zfK#0-TmUUNb^`pY2sVIg1^h$ztM~i$TLZr}@LL1FHSk*lzcujxqXyJ1?3^y#w>LGj z0i{10N&N?!U;$CX=SZ5r_sgTB{^(OnO9DW2^gsIlKo)c#e`)VGviSeehJMTZTLZr} z@LL1FHSk*l|ImQMRdHE4@vGqP1#v04tI~3kQow&T1_0`S1z-m_0T+P#fIVOem;t}Q z2xW%h{BvjLS8`%vc21(E=JwAlM9u7N#oSF_iHVC|6$9jktM-~qMd%OM8TJaxX`cE0b zp+7s|$wA9Ie*Cz+*gvoPpB3@P2xxfVaep^c@W>1Q7hb;?`L~q(TV21^^>1n5-=rKB4S~_}W1`uP= zvof7J!F-mLljAJwS@v_>{1?xizjU7cERQJ9B>_R07dg?^ocik6O! z{y04g0|Sc?*I6#1fBQxG0Wi}69!EH-sd#`R%v99ORFnn)0u~~Vf~Ct})yu!VsE$z6 z96d%$cbuL9oKSKKI6_5DeT0Vk=usN5Zb{_>eh<(vA3c3hTuZBtqv2Nnsxs8l-M zTZOf(4|}kDlFuApAE#$yKg+>+=`z27ppcZb%r)8Ta>}<=RPWqXQ-AbW=Lt+#Pv6Yk z!qV!w^$RCw7gslT4^RI$0f9kp-vvjnPU$<8=ut7 zCEPF3{*df{PO#ViOOpLvuz$!k3Y?&(0ymGE8Gr%=)nEYy*%WFiShBY!zT~sFppPn!udSe3bHC}>kz3w=?kKfZ{P_1};A(`1$ zje6VcCgf?4$$3QmJ>pF=`4a{3MUXt9Gnw!U2*f=K@I#AS4fuqp+RT-Zz%e_T(l}L* zV_hh+f^h^kYcHT22YV;717X)29W$Ib6<6k38OwpIlZ*CHc&p&v2zaftn0xl=4X}K8 znsOpqOP$)G|M9DFWrwrwm(-XmBxIDbHdy$50{iZ_>kG7`OVJ5@ZrM%e@nx5Sbs^8e z#ocp%z!gH&y7`I?o)m?yW2v2i^xg<<*u+0jBvWfU&P)V_JVD8z`1R3l)kt>WE^gU+EsiGny`-5#k= zd2zkHw{_pd)g~Ne{eFF4ifU(q71vCZLN|yV;QJ^5_5>mfg6*XMr_hUYTA(V$$x>8% z3gFg4XEJIoLJr*jHpy9$3V$$X&+L7($2m;hi`UxAHR>L33B7tuC*yPKl^4RaO@xw8 zzi9=hCw+S%xxyS)Z!6}Ng`y>HYzfc%9o{1ZrV(3724F4 zV+$Xo7feo9IppC@^h(NlCt1VqUi%uYFuuW4K7}{r79^9hNO%gcI&{>~N9YkIYRz=Z z`#w*6HiO)i zR?(8#nSv43fBSv_FE(2|+W93OUPi;LAttWDcq@j~dmNfY;=1<|%dWW7Qvy~>ivMoG%ebk|EigoQt znV{2Ib9tTahFevJ>D_JY{<&}B10Hs;=oqP!PfFe^uda9%S$pm-hCmfRQ5-wc5))H& z#WJo+QXAis-{CklQd(NtZG|~~(T!I@tpyS&gd~bWSSWyJADM{QUG0ps2)f_=ohyVx zAj@L^KdFv-jwx7j@YmG6$LQiE4^kuIshNDu_SB)%UAjhhqo5{R*K@IlKGpf{*AMCh zVaN(eaxKQ!@S@w|YyT#cpqU!0+oSt}(bm=qFPdP>h&mKNAs?~%BX89#TN}w&CQ~;ro2Ub|xj(q8=(`YZ zv$%;jAPZ7}oCmGl*IDg9M@GxmWaNEE+ zaeOlRW968M z<{V$*M)X{ScQcugF$SSAXGd>p8^Kl^^8T zUHjU6c5Uotoe{gnpe^6G>ay*sVe_U(k}dVA8)rE;UODyESoc$HA=eFruZ0)uwjQu+ zj?<<}lp-Qgbmvt)VHNNJ^wt9@#Np8h(z#3SMu6v0)Q`=#WrGhUM)3}q*R$e$_Iu@u z7Q7d>4whbMW0_`+5g6SV3UFkd0^sL;LZ&Ie!D%V6Ls|n0u#}M>4-hwpibXW)S!ix{i;T-EGn+OW7gX)Ds`!m|!?bd1I^L zwRb;W^X>;7-a#MCReLfueWL&@^GK36VlA^uwZ==l;jxb4nIgqL-XGnutj6kF-@m80 zSHiI4DZ_>_$FJLXFfI-IFlp6Q``4MAzEX9w&0gTS*bz+Al=Gp#F|Gb2SB)IJjAiAO z2WvRfnTOIWV(B*|4Uf{lw|F=h4XaQL9`x4CT;jB@>dzeEkbRJTWwDzcH^oBK8IVrf zBN(qTC`WA}CuR2)YW!KPnnz{fM7vEEJZ9itrKJ$TSvp`t#=72k| zd#mS{ImWJT>OC!V(NUqzu~M~(>vqo26P7|{J^Dn-N`yAPy-NX7450+B*g5|%sE4GK z0?ow+4eN?U%@7Kp99>mf6N!J+^Jp5{@W~8ja`LW@?^E~y?S)X#+kV?cyx~^p&NHv* zCrY|Ts#Ye=3d{7YxQhQkeP5#hb9GbX?_yi5;vCcaDNG%syCx%tO)+?@S)Js>ZRV_1 zMiI-mWo--GyxyK0b)>U{v`r^@#%|%uW*Ha+24&f%)!$a1X;+D%#yt~esO^;h1wEkcy-#6e>+JP9 zT)MJ0XKg3Sr<)e$Sy}jldPURK1e*!JI2S>0Le?NlhfHf72uz-%0AKS_M6qh;FHd5>6NqQr|P3XMDfP! zF$F-%P=J~MPnf?{%VwUfTf~7mvIXW`!%{ZN*wb76+~R%WV^oErXQq#_G}l8DY;(uA z+DldWEI)Pnz9{4jMqCUrEQ&h*@LK^LA-EftUo`68_sCCi&2buj>zh>90lhwANQeBa z%Gg+aML1nCE2+Qkx?&-TDV-?hI>csEj+v`=zLVi-%m`h|-6<$5@rgR{_(3$OIpp^< zf5Ua|``lZzue2T%pj#Y2v@=Vsrde7Hy~DO{xEY5c-}KZXx!IGBR5=#4BPKa|q9{N)3b~*kq*+xS zDu4Axy0h@)XL4gdVzJYt1?DiV!CKjuKX8Bn?>E)z%VNiG_V^b&DhQXx8Qgd7FW8k& zRQ1viv%V#MzqxB_xFUjh&~`w-iwbI!mvQZB&&xP<`@@E6t>T|khbI)6Z17&Z2{%;uaHrjtf1vI`oPC5l;E)25d=OT~Q-F)c@0pI& z^2}uDkmF|dDCkpVnx0`nCv9=1}oqG5LJm@Cqf!5fdJ1=8rTsDv;_Qdxm zA>>*!Fn+Zfv)_cI8Z%LVDBfG3({VwQgY`%9>}kO}Gb$A^EH?!rT#=W_@2POtn#(UC z!nrS+hmB|`wLH8-^lB20!|GJE;i&5|^%t75Y!kCVn3QYcWimBt?Hb{NkaxwVw7R{d zB1>axuHey9nHpLrP#+*dcAvSB`*-ZKi2+W74Si`S{_L?gwXnvvxcGylpav9U*R04< z-fyuFbxk~jmd2es+*x-6I+4y#tKK#W#U$<*3@PKYv&U3R34``e!4=CJauln{vDx17 zR>2~~Hkg_crT}gMy+1JjIDpF@tvPD+X-DeCY|;Ddfv}kgZbQcF(h3oqqTP2|Ct8WZ z>B!om13zs8JNJb$XC|5=^}Hn;Ls6qOOxCrWCDVv5g<>Ni_10xq<(#FV_^iNZ20Dzm z^M_9TUNGt_50x(lJDa=63e`uMsE$0pbxt9{3&t^vIwsO5`Ic;#8pP^eMO*5P_53*h z9X-I4{TLR$ebdyH5_enXE0Lclc3qC=Gm=t=DYQ{qs-GvU@*iqgH`D zdfj}%?QmdW>o%?s_Arl;j;FdpCwlrA%fmXLd=$|yijh!LWB>OfTSA_(Z2Nc`d7 znT{h`R?`r}w?G?F6#?LZuzKWqD5lgsf?Ror0;D~xnL`CB${|``;vgi~2nujJ18}MV zIev854Em6M6ue6ZP~A! zSdjQdkYG*1M8U-*!Zqfs!3oOM+%g?DB{t{snp!7Rk{}O~c zyu+`NW{tC!IkXPn|GG~>-_7lc-fe~MFdHYL!TYow&W&hJLXjM_Fv5KwHX<^7jG%s= zkmM)iE7f}2um;G10B0G=l>&^YJX=O?v4GIOAeY!^>#YO|>IeG#AuzzD1UL3UF~T+! zzzB8_d;rF`Dq>g9@-KIWB?omUGg5#E9Rf@jzU~PBkA5?~RtoAXR8r9!UxL`{f^?it z%>OJ%*W3rn+r1i9SbC`3Mgi{4xHY4=;3YN=Zo)kdn;C4;nJGdKE<$X<-Z&(GNlgkQ{0p(;FwMcp#0I#M1`5w+a#b>G> zhRWM%2c^=+uaVD99O#F3$AqrCKvK!EnI@w5RFJ9RE=OV1?G-P4s5vIiDh{*~AArI- zWs}bQvIOTru?79?y#lM*AYx3C))JB+ZnNY7sr!(MlhxXP>zTf&WK>p<#^V#n6=GWj zd@x(=CRy<^sJ9Se?!p!Y*ni_Q=s}(ri`tZd;1-Y@LsYmzjw<12tZF>iGk)ZHCM@bE z=y>Nkpc7f+%8Ly;LHY#!ep3E5#>G0*T#|9|i@pAX8`fN`yjawIyq&l;px_2suqm&> zB1f&PcBK_#XOLgp^Ns=QhPsCIsfsq^yG|!2<^;DKb>|hOLC?pa4qgn%AW~pq`zQWOA<2oZP^jJ&$>@F{x6H!NF>cVa zr*iJy)%6f=SvFA)vKhJ4jZbt$=pnO3XfrOj@CUMdFYph=LBo%Sx!tojaD~Kx47vRV zEQjc5g8yiJa+NE6OOPx*ZCAZ~F2u=mhH$ zb%u`)GysBpJec>9IP}ij20z07#`HryneCJL5SMMdORd2L#I41z>;2n}ZV)zU$Z2aR zqqJ}r?XBJy0#zS}oEkX}H`3+5a)qPS@%nn^$yV_*qiW~hxj99vZ6fv4ug2X;hQ-0e z_}+Z`#udjOt%dg7hmNHGAOviN-U%tV_`G{Cr)(K_~F!Rw0CoZqin>oR<0M!rf zeySJ20x3-Ip)aPudkac>-AoRPt`e>8+XIyv?UxST?pF{?Bf@n{)H}kpAf)7bZnDSt z%SCAz@MoC0L&>+p7|6AQU`kBT#ykU3xT%oAsS$!tq~8cl(N&+%p;+P8N-&_=43lMeOB1r> za#{5ZoTz?G!@^yl`Ul=k(fMg(Lt&xTC?M_~cP53$(Ae^`yw$`wInl z_Y-k^PJaCXlRlmo*C8FjThA?7q0{fKapQndv9FuPi9`Wz!T0Z1`yBEPqOU1k^lPPY zW8Fjl2s3G@n5w_wg=D)D#`E(@=d9^FQIWc^A{h_)4Iokikl($)H3f2~1CBiC>JSC6 zlwNRIMuHp?WBC<~l_sQ*L!X9P%@C89R^Ud$!&;wuJHrDBSTWVgme z*{b;k8)XuRZTiXS4!JKLnM}!gEZTO~-dYTGZnPq@Ys^sb2FKE zd+lo4V+_{k;i+n@CO5yzxcXjQWDUSs9GoM1?J?C5hJ z9K6KZy!?%Xd|aAv&@PI;x9XgWMRvWT#ngOEbDXMsbH3NL zK-1@W{j%$m)m10u-Y=ItIFO&M22+n;*3G)$a!gatg9fZ9z^DtRWEIIZM8287yvPL7 z!_X6v!p+TyYG~9h#~otGQ2Txt&55H#;hOWp0oaFgXA72`QJH})cn;#dN4+)n_&KcD ztM542YuoD!8tZbGR#*AVc7^c~>V#YV-2d@VUPPI4P=y8c}@PH2Q?i2T!&_52y3H1wBF;-@cxUyt>GRt*eUB!+r3R zSIM~@uQ1*-Vfd5xrpPCqPvOT@#rt;)c;_~WAHwpSSe7GRaXLwing9LB;jBTUURH0#u_B$Sl2U!dPPp+!NHXyHN>`EABQi_OEoU(RyO! z?dL)|&M3Xs6mB~`F0RBIHfeG`$P=eAc37>xykWn=SDq9h#v2FK+U_lGoEup@of;9pajHrrBis*)(&_64c`x4B91?}V$va?jr+%Nk<0piq%0R{#B zZ}1_%wj6Q_+&NluOtWFo8#KnH2fB6af!^tB z02=f~0O`bE8JthE38S|&2o^?Wp@ek^`JFnj=zSb?famHFd#oV&>B%)od5u;i{--ft zHW1Yv@$X&;7ND+0JVym{Mg$&32NWOY9GoRgbyZZV)_=a&cUK|Pl9_k@>NYamQhsQ1 zXa`+HrjW(5CJ9l@+B({gCZlMma1e1gHTW8!VA0954iqF;Ph;v z_60n-(K8B)3Xkg1rXS%Ov;C@*KQd+aQI{)A;(ijm4E#!U`JRt6J$QxCHg3i4ljYaZ ztI;64292a;T=(-4EAsKn^%b! z;a94Z>02X25s?wzI06NbBe1IkAGc+FUEr{6B9<<37sWC9Q;D{Fs2ff*$o`;r`aL(_ zP0yWO(u<;;vXD#ybAv2gKPsYWehyJOrry_2+V@EG0knTHlHJ51KW|g? zAuRkJRZ(dvu1VEXybakC;B0wjK83g=PmD$?%7~R_(GIb$CDWIGE!B|2YEA!PzGR`)2NK za|j?LBf5jv6#2P`*ZLz4#X+4mpfVj7>$W{0RA;^9J%jeqj~2E6`)snd4L!-cr?+_c zzUI!as_QQ{IRIgHkI}+bzjxEm3yo5{5XyS1A@R)EGVG=7H?4h}F0xD_{(e0feTVG3 zyQ3Q)9xJHntO%i1f;FhVuc+kYpWO^_XlyuGKMbS*^vgS%j%~($&(MA2#S&}`-_?_k z)B5j7Z#8=E*Ndp%?hz63yP@-OZUsXD^tZ9PKVui$ct<-NbIz*E?`(R-!9hUV0@3&z z+Z+mo6?wnB-o2BCSo|X_`>b}hBf`7fcqxE`3ABA@Gboa8P-d*j14=jp%d7uvaMn+t zT0!_{%{efoQ#OF!xs0+1BB_&vmq6TC8uKs#(@wy_^<)8cLp5j z$v3hG>o%ZY8LOuN21wH7IA6ulv|!1b5CQT)I$87>m`{3I2>LK{6g|p|l$$@{ZIwE{ z8?LDk32}*x0c|}PtF-=KAC4(hWH=|Zy!8uo146puJpX!ZR?|_kCe?a3wH#v9n zJi2-FK-8G$Kk{7m)F+6_*iBM^Eqdq0pnPAOgRq8^WE-!UQ>C3*({+9nD;m2svZ;94 z{l(cpy%K|$xI`vtHE85zU&Rdkq}GU3;aIy9fgZO)Fl(GVSA=6r!k9D|X5MoYtiQO+ zI-__28?f;1)q+T0ZA>6_q(Y-N*)-tGirhORh;{TFb|pCVnkD*7Qm*IAj*~lfS+oi- zs7_?1i4%nlZui)U+C>GQl3doE#+De}?Hs-Ayzo7cn}uKHM(eVfeG~gh8NaNc>xyOw zq1oKwMXa}6Y4Fzx;avXq@T^$rg^Hm-l$73x-n}UEnSO-a(AD~Wm-DxaueOR0Bc6R} z9r;*Syu&d%^(ZXHzxP|IIF}$)$)JY2*D@Jr6zR*v^+c9SK}{!2d zZ!f)qa$zL!D+3WEY7nA!Cs&PDOU_jtn`$2XGPQFu1Y|g#+n{ex#Gl!*YwjI{%z2?vReuqQ#^WDBontZicZQZ!L zWEqQuBmvIQ)7~1iAvL@<`UA;x_AU;G(ZtiiM+BQ+1|0i>zf4XrHwE-8z!>%AO zlGan?giCM-eg)du07NObM}T2d`aq8uc~pY9DLgej&^uMP56g2DS)Y8=wf{K&AfrwE z%HoygD?XZ@9C@VS25h+_5-o@1S%@_k+Z;T0<<#qj>_(SY?)2BYC8V36laLub#S{MR z1Lla0FDC62U^jQN_#9nhFq_{IpQ`&s99n5B2u=tx`f6`Hju6X%vmd2Sc;L8qH2QtFe5lvBQpo_?3)L zIj^+mho@2X8zpxXy^N3s91mPf5BkcE$l*-*>=B#S7HlTq=TQ{B1VeGN!TetkT+@`*Pf-B=l{rrA_KR^7KC^qw0|8w`LRa9mnr)^|8gp z0^A#Ua|$qPb7oGj>)jf370fS#X_SH1x9vi=a$g&8hcjGCH(}x|vVZKOlrma-KJk%( z%u>dKB@Ya@Q4lmCc#19uNjkN5wKf9=5xlG&WzoOZ4I|@w%9$( z3qEROl)CE5&D%3GAZ75mvM}*$u=7LK(!xi+s-D@90Js}$3<*Fn0eG)vu%M73(S2+x z0?xe*VV08aD=CTMyewfbe)|8{h^Ca8-*iNZ34saa21ry9BUHxBDjGjBv#>pn3C!{y_2OAW0mqw zvv+<#@w#w<2wf8p5m?fc+?9_pTXeqSgcL_qFB^U!N|1xPl)bXE`aIt@^)F^`FOF~^S| z!mcnl3FC7*d^s9kY)tL9aO6XRO}5mk9)Te(H-f}AfK>t9OxTI`HglVAuW^ z5-H|>O7#f_6{pTrg9bRnU9BPnREdXHMdy6k=c9jJePbHoYcFp)cPQLP9mcPbBr0mj zJAWn1v5Cp?E|(`5H~TXbPVx`oG86=;yA&_FAFtB%I7*lzAzR*NeZXu?bb4YuhY~fh zd$WS{Aw|Oq-ie5{fgRz7f=XS>-1DLn?=De6)iKG8VQSYEy42&WgVT@FY20=&rtdQ^ z3>O%;YI~4SIwyOi8eob}4eS)qYDsZgej=PL`Z#)o+xatQV_&|k8NmoG*?lK%W7GAm zI4Y+K{$#zuAra%+JZ~uJt@s@#WT&=Bb_Y#CXXp0UyxbrT!oZ^pgSb|u1K5?X&KCTa zORO@qq#FBPzp+S@^-{RJ`4}796eZFVtT)SCQXAoxd4D`Sg*kNSd(< zL&V;T{pWdUK^p=PCC#`xj&LI?qEL>hwN4pSS&k!+moZ;+X<}q9nGIV^ux*{}xaew_ zREa=Udod<32X`p#WJG9|g<>ucb9%q%{8%=4l*Q>VAKrXPzc2sV^^Fq}jKWRwTG$HZ zT;nO_FWzNmT=T4Z;%{_mg zW6;sNl%M;FWRrr;@QxRv*jmiqF(LZ4(9a1v>2y-8ec~DfBp<8+uR?+awX@Vk#aGUT z8oj*zenmlhmV5yZJ73+WnB;WD;Y|7MWwd<(;~mznGG9@Dvvqzl5scKUOCGk-_BE2b ztcJ@^7Nh;Q^0<%ryA_UbO`T&&%LIcE1)yW?A`&5o+hDadoqS3db%2NNFM_FWV+ufu zu_e_WX#e>JK0jnNLjm5S))VcwlNo4z&9_;)cq<4rO^8RvQ8St+*Mo@};6F9lDQLHL zttab6{LE81atqDlhli;Mu`Chk<{Hd|pSk30+6D2?b2t(gexs0d z{dokKL7h1QvK}OuGK3=tJBYfYP80x2`=|I|dA-OMT@Dq3{`uB+2qMBv(9_CJEy@G# z^s7)D7O@GkDdWmbn&;crg^dj0vq+`lB%5wT5$GAfBjbeWOs}g@FA00<>OVG-x^}%# zmZ*AJzT{GBo%`Vr%~_i-_CpU2#RDN?ZCh>|i`P5v6H)N5V~Ob;82!5C_SIjJe3A51^1PX`0r7Z2sVrD&nU5{PMV=ZQvc++5g=q#4a) zW2)WLS9M1NnNm;Q!n@IA~Kd%Lw0gvN!>OwBUbjnb)Qui`9z0 z^a5#rG{Kcooy@Y&M$7TnB z1Oe(!5jd6iwc^OT$>;QRowo}XA`w%Ua7OcipDZ%;?^tK*D_PsJj|bD$@sNOA=Lf%@ za`;ON+t=y^(`8}kp{(xy_kgy_ZS*PvveHi_!lHfi=zlbhw2#oCYuyj1w^hzBr5p(s V^xtGkO`+{kVF8c$qft>t{u|e-W}W~5 literal 0 HcmV?d00001 diff --git a/vsode/esp32_coderacer/lib/CodeRacer/CodeRacer.cpp b/CodeRacer/CodeRacer.cpp similarity index 100% rename from vsode/esp32_coderacer/lib/CodeRacer/CodeRacer.cpp rename to CodeRacer/CodeRacer.cpp diff --git a/vsode/esp32_coderacer/lib/CodeRacer/CodeRacer.h b/CodeRacer/CodeRacer.h similarity index 100% rename from vsode/esp32_coderacer/lib/CodeRacer/CodeRacer.h rename to CodeRacer/CodeRacer.h diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino b/CodeRacer/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino similarity index 100% rename from vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino rename to CodeRacer/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino diff --git a/vsode/esp32_coderacer/lib/CodeRacer/examples/esp32_coderacer_beispiel/esp32_coderacer_beispiel.ino b/CodeRacer/examples/esp32_coderacer_beispiel/esp32_coderacer_beispiel.ino similarity index 100% rename from vsode/esp32_coderacer/lib/CodeRacer/examples/esp32_coderacer_beispiel/esp32_coderacer_beispiel.ino rename to CodeRacer/examples/esp32_coderacer_beispiel/esp32_coderacer_beispiel.ino diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/keywords.txt b/CodeRacer/keywords.txt similarity index 100% rename from vsode/coderacer_mkII/lib/CodeRacer_MKII/keywords.txt rename to CodeRacer/keywords.txt diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.cpp b/CodeRacer_MKII/CodeRacer_MKII.cpp similarity index 100% rename from vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.cpp rename to CodeRacer_MKII/CodeRacer_MKII.cpp diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.h b/CodeRacer_MKII/CodeRacer_MKII.h similarity index 100% rename from vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.h rename to CodeRacer_MKII/CodeRacer_MKII.h diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/Webserver.cpp b/CodeRacer_MKII/Webserver.cpp similarity index 100% rename from vsode/coderacer_mkII/lib/CodeRacer_MKII/Webserver.cpp rename to CodeRacer_MKII/Webserver.cpp diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/Webserver.h b/CodeRacer_MKII/Webserver.h similarity index 100% rename from vsode/coderacer_mkII/lib/CodeRacer_MKII/Webserver.h rename to CodeRacer_MKII/Webserver.h diff --git a/vsode/esp32_coderacer/lib/CodeRacer/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino b/CodeRacer_MKII/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino similarity index 100% rename from vsode/esp32_coderacer/lib/CodeRacer/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino rename to CodeRacer_MKII/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/coderacer_mkII_beispiel/coderacer_mkII_beispiel.ino b/CodeRacer_MKII/examples/coderacer_mkII_beispiel/coderacer_mkII_beispiel.ino similarity index 100% rename from vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/coderacer_mkII_beispiel/coderacer_mkII_beispiel.ino rename to CodeRacer_MKII/examples/coderacer_mkII_beispiel/coderacer_mkII_beispiel.ino diff --git a/vsode/esp32_coderacer/lib/CodeRacer/keywords.txt b/CodeRacer_MKII/keywords.txt similarity index 100% rename from vsode/esp32_coderacer/lib/CodeRacer/keywords.txt rename to CodeRacer_MKII/keywords.txt diff --git a/CodeRacer_MKII/library.json b/CodeRacer_MKII/library.json new file mode 100644 index 0000000..fa1cdb4 --- /dev/null +++ b/CodeRacer_MKII/library.json @@ -0,0 +1,22 @@ +{ + "name": "CoderacerMKII", + "version": "1.0.0", + "description": "Basic feature library for the CodeRacer", + "keywords": "coderacer", + "repository": + { + "type": "git", + "url": "https://itsblue.dev/coderacer/library.git" + }, + "authors": + [ + { + "name": "Jens Noack", + "email": "jnoack@itsblue.de", + "maintainer": true + } + ], + "license": "GPL-3.0-or-later", + "frameworks": "*", + "platforms": "*" + } \ No newline at end of file diff --git a/doxygen/.gitignore b/doxygen/.gitignore new file mode 100644 index 0000000..facb6f8 --- /dev/null +++ b/doxygen/.gitignore @@ -0,0 +1,3 @@ +/html/ +/latex/ +/xml/ diff --git a/doxygen/Doxyfile b/doxygen/Doxyfile new file mode 100644 index 0000000..5f7fb1b --- /dev/null +++ b/doxygen/Doxyfile @@ -0,0 +1,2492 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "VSCode {code}racer API" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "... better know the details." + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = ./Bilder/coderace_logo.JPG + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = . + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ./CodeRacer_MKII + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = ../../vsode/coderacer_mkII/lib/CodeRacer_MKII/examples + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = YES + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /