diff --git a/.gitignore b/.gitignore index 187d706..81d31bd 100644 --- a/.gitignore +++ b/.gitignore @@ -35,3 +35,9 @@ intelhexclass/doxygen/man/* #Ignore extraneous Qt generated files *.qm + +#Ignore extraneous MSVC files +*.tlog +*.obj +*.log +*.ipch diff --git a/Debug/intelhexclass b/Debug/intelhexclass deleted file mode 100755 index 4789ab5..0000000 Binary files a/Debug/intelhexclass and /dev/null differ diff --git a/Debug/intelhexclass.d b/Debug/intelhexclass.d deleted file mode 100644 index e9aeaf5..0000000 --- a/Debug/intelhexclass.d +++ /dev/null @@ -1,4 +0,0 @@ -intelhexclass.d intelhexclass.o: ../intelhexclass.cpp \ - ../intelhexclass.hpp - -../intelhexclass.hpp: diff --git a/Debug/intelhexclass.o b/Debug/intelhexclass.o deleted file mode 100644 index 933c8f0..0000000 Binary files a/Debug/intelhexclass.o and /dev/null differ diff --git a/Debug/intelhextest.d b/Debug/intelhextest.d deleted file mode 100644 index ef7a46d..0000000 --- a/Debug/intelhextest.d +++ /dev/null @@ -1,3 +0,0 @@ -intelhextest.d intelhextest.o: ../intelhextest.cpp ../intelhexclass.hpp - -../intelhexclass.hpp: diff --git a/Debug/intelhextest.o b/Debug/intelhextest.o deleted file mode 100644 index 48a0b7b..0000000 Binary files a/Debug/intelhextest.o and /dev/null differ diff --git a/Documentation/circular_buffer_module.odt b/Documentation/circular_buffer_module.odt deleted file mode 100644 index a4778b8..0000000 Binary files a/Documentation/circular_buffer_module.odt and /dev/null differ diff --git a/Documentation/circular_buffer_module_release_process.odt b/Documentation/circular_buffer_module_release_process.odt deleted file mode 100644 index abad1e2..0000000 Binary files a/Documentation/circular_buffer_module_release_process.odt and /dev/null differ diff --git a/Documentation/images/cbuff-module_final.png b/Documentation/images/cbuff-module_final.png deleted file mode 100644 index 0331130..0000000 Binary files a/Documentation/images/cbuff-module_final.png and /dev/null differ diff --git a/Documentation/images/cbuff-module_final_small.eps b/Documentation/images/cbuff-module_final_small.eps deleted file mode 100644 index cf39070..0000000 --- a/Documentation/images/cbuff-module_final_small.eps +++ /dev/null @@ -1,337 +0,0 @@ -%!PS-Adobe-3.0 EPSF-3.0 -%%Pages: 1 -%%BoundingBox: 0 0 128 128 -%%DocumentData: Clean7Bit -%%LanguageLevel: 2 -%%EndComments -%%Page: 1 1 -save 9 dict begin -{/T currentfile/ASCII85Decode filter def/DeviceRGB setcolorspace -/F T<>/LZWDecode filter def -<> image - F closefile T closefile} -%%BeginData:; -exec -J,isG0E`.##D>EP:q1$o*=mro@So+\<\5,H7Uo<*jE%Ilnb_-W@#$k]AnZ_-jK3(_I&WJbL,>(FssYAn9K5mNLB6BfIpZ=6&i -M+V9>r!eAXZ8GpP]JKU%;f"X)ck-nR)e*6N&E4B24VGiJ5`cg:4iGcEi==e`WLl -"?4,Y^i09lZ1PsSE9Z4%LaT]5'n^C3,QbpkU_NH.+IoN4XX4.-* -2gT+9f3.g[Jq_CKu&B%0t\_7Cn+VLa!FT>KBG'JY06@"p71DRqB`lXG@Bh!0r';hZ,Nbpr"7e@G$'u -VQ'"_*63'SI"pUjiYR=,q]BGNp6F9]bu7d3HQP6cqVNC\@d_uS12LFf!'gul(Yie+a)Kl@'OdU?pR@dqgZFb392o43l$\B)A0lDG'Pho,XCb=k7u&QhV*l:r!7#!FSoX)0*Hih,;[OG`hK6)qrF -/_4F0onpWUWa?0t7^fVC;:5He<24l7]I1I^>BtH9$0*.0J:lf8VM6 -T5p8qqL#0u2A+)^.^U!`B*!(':"N#:6/eR7q'p^:+&=Fu&ifE$ntpHE*RD@OGS_M=iP*[A%8O"bqlL -\%PJl50^\dO"u4#k:(\O^J[\+?`3HgE4>WH%7\CSA6'oDlge>\&9KqJ.l$eU[b*3-G9#m)dtC5*O.2 -1!'^jYqCXN1)Lr)7RXb`[!3)mtQH#B?9?UXGbf+gW&b)=rU4"&t'F#&_"9V/-!N.&U.652[#3+R- -/CYujKE2j^prMFhq#I?fj$,p=5NfU,7Vase+=GZ'*Uj.PW1\OJU%EbgTqEFjW-")?mQQ3;3$."R'S4 -%@"2JZP,!Z`/O+H5E7khar,LGJ$&\9nd.D>eG4G(!Ybr=42%qXh4SH(W1]9PEPH;@QgaH@,/=kto?m -!\*u;UbaR*@kud$)P(eQO4Yhp`JE*GQ89f3G%F5!'j4s!$V%r^]4Nm5WF%Mn.7b'p^DaL>QB;k$3J: -#80@FhiKkD^4j0c./gKGe[&8ZmArU^OCj*%roU8sOktnV2TlcsW?IW1?i,*7I`Qkrr"A=OV70D'd!+ -fO>@bYFX7+LAaj)Y&8.a^CdRW0[sAA)]'VFSF('>/9lEsBDEa=&np"ZG!!'%'":# -bD!lKfo!MRR75fi0i+C'/A0IAqJ#SS:)rriqk*'VF,$A&Vl!<@0&!E.&DKp+f8&(DgYa4q7LG?XAF= -0+X%9[PVZE.omuUg@@N3*i=#TsL#jFrNm&B8h9I>#5DdcHlYi^a0[`!![;3)dPbuI*+,ek^cXY#9Oe -)\Ub%M5">>)`#o&$AT\bQ&JuMiJ5?N`ne_B4b)7?Vkks$t'U!u]&HPFt$33Us$A^-&>.H5_1T%iI:l -H(g<<=#E\1qII%5(5^NlIX.YDa87qFs?4I#g5/3sXCA*+SmO%KHP6#3Z'i>'LQXJ3H'q+;u=%&.5*2 -*fL)7ciK4709>:DX/DDjJJb3MCU*h$j8@)k9T.1U>ME -S*16f^Bn=Tl+g"6:T8(Y+!>=$WX:t^A0$Wq"lFd\3TI@jsD8]PZV=k+Cr!mk*NN/.p3(!qT!;V-]P: -]LQi/r+2Rr%a,%GG_iXeWUoFcQ;lg&98F@%-35$)HqZ:/"i/co2^]9GuEb`L4Q;j -npnWgo%?&i_e%buV`l[=>oKe[F\nm/]Kh-8GQd^@bq5DRX&*[B"9up)"9Rl$#QVXUP*5#9ZVMN&]bHpBKja4s(9Jr:4$ier91V[O;L@iU<+I'O8#4(:+AGS]<@^U -hO94jeb6(A66:+"M:akd([e]:hS*XhX7Qt\2Z2bFa9i!NX.d!\Tgg4XKSB)fqO!J;Tkd4-Ii@l[3ki -Npo!'NX)/tpuW@CA,2p]\H<+4"O"juE%rZ9Y,Ub\:AaU&6Ys"p3]a1+p5r&5$[hY-M^rnB(\=cn(Ug -WZ]E>K*rTE9Ob3G^lor8+6._j8fSkFg`D$Z*s(^H%4iE+g&PQi*^CJ]61P(#lMW+Z!^I"kW\=HbQ8V -L(ZbR-Z7A.XOro]n*&E!O*d5QjF=(*?u%I"Cd=A"EfJ)%ja>/]-c -pBTD-!Afno-+7Qr!m_HqBuiURieO<(/5)[.Q1AWQu?Uh^9]go]X+0iWE$;VD\&BEITfbl$9`#YLrOn*Qeacqaf6<%Z![+ -"A=@60oPA_B+9$)WC*%TrnA=ZlC2.*J*8QJaiA"iW9NB!Pf6I+;GNc"orB8E[P,ca9jhC]^BEomdb` -K;ImBNdfZg`fo0D0#N5)'f&KTLg5>f^"`WIQJn^&r!g0";O\%NlXrpHK`Jk:Z@JG5$kUrfgZU\9W!! -r!hfZ142TCD%E-4#!ZdXk%'aJ?I,EkVQ>$t+ic)^2L-U[/ucqJegO$:?f7tJcN;d!8 -L>u3eJe*Cg'Hni=?m(KNJaCf+kia!PbT6eZ)e%_D_6P/VW#MB@*21j`J`7`$.Q?fu!&1&G^_?gB(]a -/.1*?QnFD_-\r(pi$U>c#A;TC_uUmL9jpkISYNNimHp*U*]5][&t"]I(+6UHLlPL5^ZdVr9;[tY0pb$G>:(`Pd!+5qkmTF)QfaoT>i*?[%oTK(@b3%ckTt![YjY#>RkrYi7?'qa'j?M-"`RN[B:f?>$#:7GmtL%TEfM<$W%R=c/tqW#%W -VU8!0r:T;.'O#^]sio>jq/1I-6g!BVMZHeBJ$b!/(%H"8NJDllLdO*cR&r@G"Cbo\j0\7Z(A.^^Mn^ -&29pB=j?Yad9S\m"!.p38oSQ*[&SL&ZtWQ?Bb21*62Vef:`W:p)I`1;TopI),T/o%!MR"E!%K#Jl3" -+1"+oY:UM'ZS%5iY[+81t670c?P$3f%2da\i+ihE+$gf0n+1L/9MHnpH?g2N_PGE9u">e/lI7)t6u -"('7o1mVtrN*b!h_b-1jh^3.950nJBfTK3-E-a3H1\aOcH`E++BtRFIin_Tp0q1Id&q -%3HVX)oKOCELjH+;c+//$QJ`\O^1+i\(!2^GPK*i[;k@R$OMW+ORjd[9NAfcId"5jkXpiHVR2Y3!1L -Zmq%irf@hno.[ecq+5!#El(N/7+KsZ6deaChc_QnjWg!!9'[96&5L`3#Wt>"C]4jTLOE=5_?d,/mp" -,6YAn$f(NPK1,Y(6cFX04e>CW4!#De1Y8gGKrh7>,^(Rf9=4SFDqEHZc+/O+AUO8/A$[9RIS\ineXb -b<(`/uC^P\&:]MObR*6s2t>DZ%Qu(*2uM[J"cmqdd)"RSE(8L+:3uKEX,;_fH*CQU-\Y#+n5)s -j8_\4@7P&R6/\HQat5of5bZ+]6/ViQ2?CbQ!lU*#bfhJ3WT3p:gaFM@J_'jrC>/F2GrK;crucl@sB0b+ -1`<4kK"a.`@SptFOrN)l5^B2K4Y>L#/sB6((2aoR@ELZG\'>tHZ4ZS^E1^sWL?_$`T"H^T#g2ERB0Z ->1TcMu6H&#<*_'\..?4CF!oqa:4@Qo1RMm78?7eJ$1p=lt2_JN>@NFSP*_%NDU';T*:`HDe*a5oO7, -A!5M?BUj!sAc>^^DeS.eA8WCb+RqXtI3f]"6>TP$6tLgO`#6p1('jI\\+b!%&PU!X3#2!!$UO+92TA -Ootgn!i.#3A@kr3"eVG6TCnN9Y-.1iq+N0aTu$Y;C#0oXn[hgFXNDMnU$Nj.*1eW$+%4RP,>2AJlWd -R4\r?irg/,eYOFF%=f_S30#(VC=*>gc-]'>_g$Q1>V6O\nEUrXsnq)1$kmOC2>A]d.qNmZ5NjsV>q`D*23?8@I>5Q6q.//?Q;?E!$ -2+TNM"a\8&UXa$)J>[gjtqe5F(@P/a=B#nio6]dU^k!-:f4%l:kHAQ71l<@I,+NJAdH/RoIS@->Sf7 -KO1TRo7uO&7'(^Zb2iK5FsLUE%C[0hE(^E-S[Lk]E?8o;U#'<&M6n7ScO=-:g4I=9]:]16[h;4*?s,U6K/t4>TEqM+$-b1,?t?R1frIkY*;o.EA+CZ#llJ^]U"sbaO06m$<1PHX>q&>2YZMut(3*_S*?k+[_:R97Op!)D!em6 -F^_QpWH.]6+HoJo=dq2T;]3neV@R9^GJanF]llP:Y;'Gb;+m:Lb![$-5VVD(k+pK)tigD1*`"C=$OQ>+s6/BV.#H0rrOEL2E!C?S]s'>_cIk6^(^S\fb-3e0S -aDB2.boud#U"UQq>0qA!cAi+"arDIS$oGLuUSst/lX1`>5TR]0cbk,N6IZskjr=K1*A/*-^2=$?rWF -O0r1HRBi&E`I0+rC-91<4i,`W"=0ESt;*ekr#Qs=)c%P[qd+:b;Jp"\t^4W]ZN_r:7tIQq9Pk`egf! -.Vc!0ouA<"9\c+J8uI[qf]SY%_#[%Y5*=T?Z0S`igf\"]RTteKr3E$G=C>rQY6X-n;t@00?EVa6N3(]DNF,ndP -Df$`UONFlhVc"IQi8m\)[5brI&55nR,0'3!')4AjL6@?2"4&`Uj-11rotB!8:nt(]8k=%"A<[0@6@t -p_O+K!ap6I3#DXk7f]#4'Cn3^R6KM(cjS]"n9QlpYP+`brpTphJRH8Y0Gk"_^M2"bBFCd;HG*Z^=4= -G,pk$?=NqdCUdc(@Zk9(lQ*h^"q#6TM7/.Y$T!'h+3T`@.\!mmZh#D"SG633kITGjF'?uR*7KRkg!Zm+f&pU"@WTF278&>0;,/CcP#/^E -rFoVSoU&+=%cQe/L9E8N$$oppgr5bL<"/r2j8)gn%SL7"mqB"qtp8FVIJaeVi8BKSESP)Q*Mk*DLdY -s`Qalnd-W^FK&!/[d6cE<,u2%;6t8-4[C!!48Da'^(cIA6.LroZm$q<$!'l_##M<6PC2Hi]A^/;O?U -PAK8Mb=DbbaJ\:jaoEgI'F;2`-oY91NBG&[!8mha![#Oa0EFt-dHZ"K7mYk6T.8S2_#Zf'"pG$!!!c -uca-l(QSd5*!I\#YIp6-Pr=konpaN:ld*6Hn$"9IHe64^puljsYZG^qZ.5bPb@U]D181=jpQb;]KPC -S`E\JEfB5Fi2">/dqgh\utlMkqWfr7d?"L*21Mq1n&s"g>$l%8*D"?*h^_t%jKr44:#Ec&-2eRd0]b -oTAWfeJ*LDtj'(e4tYQ/p>!$U3C+(10S -!J5ik'\UsN;Nl2Er&XYmU&Z;E!J(K\ncOFc/'NDABAr5IU>SW[fU^qU"99q7lDT.pr6b(\a(G07D;A -hu."B(+fKKguG]5J7ARNe/%0F;a/>Qc-HIIkC#QSZ@'#>h9'm5%jrWC9X'`qc:GTfDP4HFgd+`,]uZ -Z@*SbWt>2j5b9A;=m!VO:`Poe.%Jdp'$EE%r3:5ne7jEe&fG8!<2j9?CYX,pP[ZeKi:JM -ZiUA)#fDl/M)'-]CF:jYTgdns:,3gi^O()i('#R^TCSEGRn.=/\'%9)/@?X.1f&;c3!@#Hf9Hg9V9T -rUf3fM.+0+mPN#Is7pCOCC=J`'XcH.2oV/.//[Ggq\^"cqRAFXY$QT -^X$R'35?K5PpRWDL01"&E,RG;BU;fr`jiuDO!d2-Dmd!7!)hDn(V@i[g&L4MZ:":t87L$<=VO7WS*) -R9<%`?hUHo(GP/=T0i2l4+=be3/]%XWPMB2#meb!/E:N)s,Fc70o8a8$R.XNFW/\dVo:#$,ercJ'.70WPdk9Z23!7gZ;X`>WMg.u@keZA<7T#+-jNR=(ul]X#$;U*+@H3T+ZrYb!<< -rT5GmaC9PL*&`KKsiW,hZL,G]Z2'"C"ng$_p14H,X4l?nFYCYVi8+J5R%?Q5DA9J*9TF3rA\:/s+)?=_ -KTJcpbLUD(8!!"7%5OIqBR-Kl)=m8ieE9.KunVEr:R!qR7B!+HCk2'8VFH4?RT4bgc)+%9E<'bD="&,6>V!!t7sUq2)>nmu#c -!Nhg_GDGM'^`7ugH_3od4V\E/!&l#$%H?S/?SNTB"F,:'QEosO5r\nTmU])9GG8^:MLi2oa.N!ZOj# -?SZ;u4h)!5Ti#I>pm7=9?@-0#-S6"ODZ`-[K[\2ac'f,dkk:B@hG"peaT1!&fZ7+q4Z+1&FYe7`EdnKuge -4G4,&aV(cdXZ_^KEg+hYG7]?#"j*`hHG-'s7n-LHB&oNd-B%,3;3o3igLh<@USHm:h+%-B`OGBO9#f -uj1e^6V_C2S,PfjWC -m"7fl&:rbAH&WuC4S"$mW$Eo*i"EeYbbi$P$I-R&Q*pdtOa9P0%g?5sLCR3A%KL"O$\0D;$,?Pq!Pe -\TNo11*LVsN"n(\D(mf%gqF73QO.mbt>F3^Eg6h+J@!$ecFMare+*Q)]1_u\3cMJrtK^b[RLgqHP4, -WPk%+_4U%?:Jf\ra,cp(=s_Z50BPtncc8/>gN[48FY4XUU@1aW5Q[,=s-3k/bqV3-1U,A1Rk=HQoJa -Sj0B,\ZPbBaOYfckb&TVHT#m83O=WAP+R:8igWL+\kQ)$OVZK;7jI7nMLE73D26[M7D3J9/5WAiHVQ -\;N^]a]\HiX!/JQMsY3#IFtEr^0-LLKb/n9+e&$4$>5!3(a(iaWNc"H]@?UCtY^PBT:q&-r"O2s>Lq -d!2C;l4,56R(3cY$dgPp)4&FHLg+L*@B>H=pBRa3LKSX&=FD!Dg)9+`/l7XaOfX<%XG;CWM5jGk,*] -'9#(WD4J@l=.J.9&8`Mm=2VU8"n>S0=/f//mh'Z$?<&B+p:"d`DWQU.X.n8X=NF:1V?PG!C5&-3&u# -+(4JS/@?O1:3PGn:8R`J05SW_:X;7',hG?J-5rZL_d:0%@R!?$Wqlt8kbH-Fb'RM//Ss!Yl]GhnhKt -A_\1)11S"qoHj?]O#E'u8YciRBL]D+W_cR'B.X[*+e,X03'0(s]U+;gsV^#n>&bps5na7kERYsg##6 -9ehaI7kIU^(T5QGArfnh-$0Aj/$V;&K+cJ_)!)bTq3NATgF1Bk9L55np -TEL.0'F37p(Pi/*Bh8:B&J#XEaCBQpjLGm=UoM[4Y0K%<800!1P?MF73S=G-Y_)_&-YNh?@_TE#eGJ -!'>5!"a/Vn7rR0D32PW`iLNnn,f@@Q69pR+0gPI0o@Cu1IiS61.7F$4>FYL@OetrJ/OoQ$,;!A>6`` -7]nh)e:ot^Y?DrC"J2%nLaPr;sIZVF2`8Cq2fEht]@3?Bk#D`Wc:iVo;Ckkr\kInK!si!1Wj3*>nb!4(!(VtAMr -cYn8-"0fc`:FS&1Z<4Qie"p!f8U\+Q.MLn8APJRK.#lR(Vlab`rNX)@*cl#7u1*:jW_JAI%,uMk\dQ -0bC%_"Y1.C%=4K]l\C_kEepsnX,-$GR"uFf!/Eh.[[S$NaEnHq^]7S+!30Z3Zf@[aQ_n63Zm4d2]dQ -ni0bhD,M=:uU0G=]>FU-)<1K(gi^pJV_M#]N?!#l!;;V=`7T0K,\N2[nYTaV8N#Cm*]!$QK86`cW67 -L'KJL?NN*_SM$(#0dj'e3nA6E;Bg17YeB@Q"YGn:lNkf\JJ?Ldnli>l8Gu;XtgR>_tb=.nENTLHP+n -U#eTX-+EJ(gF,E5-8b/5TfEiCV%@CZVR"OG(gV]Z9OO"YM=_q"JfUX,"$W]NG]Z&_W58=H,oC(Y:X-!*Fu2H4C1>5Yk4#LZnu4Q'OcG;U5(&<`!glN=^uW",L%`MkC:d -^]TW@F]@(ELs]$:aWQIHK>[K'$Af`-aEiYmHFVUrLEQVPJT[EGG:[J*(e>4h5SF/]`A\J^1"nEINL* -n/F!'WiJ9d!&O;S$a&iSAI#Iog0@!rNhP[.9tL\@H3ju:;ooFQaf9kW!?"I -o&;3ha0nqeES5oBG=/F#GHnc`-AH7MmVB?&n5^sW$Hk=-FMLqoIl$.^iX+1o9O*NUXC/:$b1_9?^,= -qjN?iqJ@K9:t9;rhB/A_te]n1W_r/s(Jfpu.&$l$sImTu%dO3Gb#+K;$35+m=S4U`Kl"OMH)Z -WM^:?B,G1NiTLlhd`/%=[9nY4:AMd-H'NnkA,m_d!CdTMID)AbN84f\^K@[i&;#EDW_!NrfL+15aQ( -;PU_dD>!(cB_+Ef/%YDPQlR[Q'"c>R7%Oj**_V>T8/>rCcLt*:L'0(d"p -5"6GMkG3]aENM,I1IG&VW\>JO:Pdlo:N;d!(A8E/l57k9E7(qJ9&JVBGLVVIh4#SO8=id&QWCTpYsP -FAY`_6j_kf*,8StGMEh4jR#Ka?i&@ra>(C[L_)EgMF(9Sr$p^c)Po>P1)F&HM..I]G-6-(p1:o6l_t -^(QoO3f*!5]ADLiA2AkQ1u\XG;bfOU)/QTF9O3:I<"ei+5dI%X_0&.2[R@JQNY;&Hi?T&;R3GYk/P6 -S=h'2T]ZtmeH"hkiuh?a_MHG2Sj9P'jThiZH&S+EpKjSUcEV4<;G=l,-]MVX3*Eh0>^q=Y9\?"c)o1#GD*]!\91(NaP#F5? -o-]8Y3pAU($+':a*P)fQW+LJHq!;&d'GOY#f<&d"^i4l?sjHE[CCsM@T4%DO)0UTLZ33%C&:0CM -CD9@Dbh0^dB%k$$33)OLWKs<+9@]"qWXD*'_pnuW/A"8R8*B@lf>,TUTFMEYm8p5LLD$^:oki+#!S@ -W_#T;OSBP.l2`h%8n$+`"nDqL`RmFJcmLRA^(0a[oa'cBjV);auTIlq#pO'e7W'& -ndJSIJO_kuJ2$O'^^,HET,p$3mWQB`Gj/LJ2JnLSF>AW-Ybdj$["(3=O*GpWd\[7J:V5" -;Y=!PY'?5iaW1OAqTC6k10+9`bU^_Slg+rl99C%Ch=)9#%i*`++D3I`AS_SXYp^_rP4>;p0s4Al+=" -/:!VaHUWR.am"F[;VpYfL[Hh8LnmLqnb#Wr*46P6Z`6FOQe+6_,e'LHL?21,H.[KDTq[?._hZlRL2V -#f_g=eOL5VJ:$>Nn-/l!V0b_.Hn-E:J=;!3%+-hZ5.9-W-F -,"8UGB^b([Lbo+TT:;;IBWr5l -C[I++OYCWXAZR5G%>AciNG)H-]h2q5a?4#6I`\dE,(N6VEF>?r<<@ek6pB7ACC_,np[iJ(EVa8/(hn -r0'>&:TDV5*"E+)JjA7=51g/Eej,?92Y&I0d"JI,oZ\4Sc=MYC@uQPjU,F)XFNTe^fA;m$O)._i,D(X#C+\gH//CS7 -Lasc9:s[`%(HORANXunlM0$t%',Xet;VPp -Fi>dGo[8b`@6T&9rpaZrM40aOYL&u:'YZP"sL2KO:d>h;M=`po[8r*"TmXFtR6X3o,AY2p,d_b@^!A441"]D[+.\Y@0L4%W@P6fCWgEoX3n/(E[W%`G8s5;/QCXaps))ifK:kRS4^DraI=!-aX97E$m]bd0$\NBH^Q&< -,-NJ;BQueYUa"jdmO'&iS=ug)c(6:+,T&c(?HLr69bQ(^c(2mbNeWlI5,1Ou!(PY0ETi!^e,7BBlo- -\;hsS"iK"-7(qujKR*Ym^`/=UXNu3WQQPY8@)kuT6pfu8YmNgH*X@8[G+GOp2LHrJ(5p9)9B#`6*iF -;?HQ@lL!dYo&:7lEb`[_=-1!hJq\Uo\nbeadM,?"h(LXFRacL]krrMq`-CgO#Up\:?Akj -X&gfKRQ54`DZ:W\u2Mqk(o%6&=3CP_=i#BB>!ZUT/%31o_hrtJPR*oL]DK -Nro,$`F[%S^4F*#k56++D!=oe%:5>eI59uZO.0'Q:$J5GJi"ZcQ81M:,q*oUa4KO&k5fZLL"^O`nZ' -#lalOp1U2[!9;J-?Fg5V$qe-#<_u:_a%^,N9e_.!d_J+St(BlR??!SrWob2i"?i)uq#*!5_D1dUF4= -b]J?L`=>/UP$'/O*-oO.$9f!K66AT\HkA+,Wm4Ja6n!a,4>]TLJ:J13!(7*l0Fg;Q_mUX`W@97UYk6 -n;`[cjmJ#pRL!+@&l!JE]CPHYnd^_#]M"4?\&Ll3V8M1m#YR!=XRdQ@`lg`L$ZE.GfS"%^2#?N`cHH?jY-Z(_crioIF`G#ue"4-<^a-D.N1M!^Y7i#L7?`/g[k2!-kSG;BYd=-8@!HP#0"tAApW -BXQ+gZ8FKCM%OV6B`;j>d38@'lJZ%p2:DNY5AAIaVcbOkA0E=.h:^oNp0StDRDp1>;o#9?'#'*;Pa\B'aB):r!m+(Wp8PF&#*+aFbGbKuq( -dch$fCWL?\#RIqZ',-/6Q=oDBGuU&LdDqI1*J8`XO/_mTM:`7aTI+WIq?R11kR4'a)FC3nP1KrH%iu -AIGfDQ34pVh+!$fRD3VPfD:-*!i^`^6Z(d/kl3GSX\=:84"/NA8q66=(65EF9s)<#ASFDdn+&e\BZQ -$^4FN.Br=U36Rs=SdJVdKL.Z>i"[FV)h*0T9"Q[3\Zd/?aFqtB5QJ8(o%$%KTE()ZXS/3 -@&EYKfnoeZuJIc344K_g(*op"E+nLaOX1`b9AbqLW;qc3k5SX?n/.R6X$sSMO'-;goH`\#\W=l=r4T -l@0'(ZtFJ/Q*%W-.Nhaj`;jptZmafQ.O81-M[LVSL58k7=i]jp.,D*u;Km^n;l:QI;'NG2NZqE#P)D -3tH)EW6Ki9gcMPn$m1.VC"D8$7L+puL5-lS/SaZZ?57fTA3^/1YRC[8TF1mqPQuc42$SR_b"Bp4Jmo -O$N#4hu;!Q<+&JRS=:*`eVR#D,>;=$/0W9JA5bfX=@`*Z$N4WX&S#E>Ac'7bG$!U5F"!#XucXip]u, -XiP0E!H)f&pL3%'";>s"?X]?mil9%-`JrH!fNp3](COej,'?5JIiCq?u,n76sK`\3<(>ck^PYY*KoG -D7Y\B?!tXN]F@tW8!/[.G!2D4LV*P"t_`2j4J`';l9^p8Pr.LFll\NSuY9.a8"Za-k5/:?bA"Wmfb9 -.4f9);A,i!I@&-T<[`VC*Im?FQ&TQiM+P%ujDObcRB(gs9,Q]-g#WJ8dIQ!/?g@&_)3%n`W\^3;cD< -.^MSG5YKeC=THA67M"Q@_qr9L6hCEl8RMf[7VMN7K2?c"&_^h=7_n'/"S\KBj>k7?mGd0np],nb!_@ -hGDIpcD!6>67OI?/=)eOP.+l';\_#iD<#^MO@aR6tPfO+>sNEf:(W7#FV*!8T7/5e%UPmVPl5E -U;Y0m(#]HT7[+D&ViV@WBqk0U6[(/GobHsa$skH^G5:9L61i[?l7dO[*/QU`uiNM,^@$Hh1(3AfGaf -#IUUm7V%+UL/RS^m)`!q0&7_g`^*%Q&(HCT=b1!L),_9P-!U%M.`rR`5#tKkH"Nul:\n\\?-Kmd$5[ -HbX@!iK8@b,oIPI!,#JXGP -$PE]3ko4,KG%JM_'&s%%e`_:=aNQQK#k\O)"7&8:DFac__ou+'!6EH;Xl:HE+s=$`&-5$7/\j!C!%b -b!ecE`>p'i-=XDmWEKE7`@"Q1?*!!FeuVB986+6>h3JaOTdE2)\c+(AP%X.h[*n/lDLi=8sBJ-]&2U -a.SP*'aMTiU#QTb,PKj4Dm4X.#K^R3ZVn(*2/6,U#m6OScK'1[UJk1U:((HiW,!Hng5?="UHR@'_;b -,*FJjpWtZo'g*-iTggSn]%n]M>ecJNj!Iu`AJ1+p#)X3,I=!TE`TGdu!/n,aoJ( -0CYmIA-5p61Pn%Q60nd3.]9X5\(tP49NAETJ9\bDR(:>:`JAD(]iA:5Rn^kY+5UIlH=9R!oa4*@%c] -Xngf#1,'Oo5ci?Z4+6OOf.)LNd=PQ4c*Q#*&Us-_R_#_>$oj`FOLe9]_b"[KO!8oU7+QMVC+!;,(&8Y)pQlcno+#;hEJoC^`n1tC%*s=dd89U<]obA^+fqiI/ -KM73]Fra6R*2/`;J_Cr,KHI=6!f9;Hj2M.3X=[f_Ns`?5dlMu@=B*U(-LJkp`9&.=T`E9%+p$=?@GE -j$mcb6]a-)T;^a*+-BUM=\=);ifO>I"di#aT\*euY,_>(%Hr$hp),sl9NAK:H/tp -;S9M'*<.+?j?q(3unIID_3W\Sg_9e$I_'D=r(SQ-TTr]0]-643 -_-NGP^k0O)Vn/oaA1XV$;B'NC_7K@6,-R$t]dH2dTJf`t7XeIKhijKm1L]FCC!Xl[\b5dQq+M)Ps*/ -4:j,gbCgX9Bd;4e^#]_;_)FN$#h>-D1nqM\J:J0eC*E1>iEoJ,fVc$6MoY+(--_#Ukbl&-5N;!9O?< -/'8p9Gohb!/<)bk`g.ZSr..0**KlWg?l2R9j=dFV+$nn+6.31"bkj]_(kIJC0'E?!2?KX-!^a0n8!9 -[lkQ4_B!Q"c.kcB:9+t'#hs(C6i#Sf2?$DiV^oKh1T@FdfP?ie%WNioA`i&8YL]E5>*0#U=2"Pc/=n -,]1I"9Iuq?re9qi#`4=*Q'TF-n'AV#Tp5E/#Xf(bL-Cr(jQYmFAgZiiUR%=f"*D-!?`A5a$h+=!@M= -DH,2PJ_Y]_hPt)*!?uL"TE\^MFH'ZA>G)TM"#^0*?3-o)9Hj66,)Q@KEc>c>e`R0ML#a -;KmJp/S+6%SgJZ]pmoH)u^:>t=W+D:t1h?DhB!pd])M!tGbV+h!p0*1Vaa2Ass8f[3-*MK2G+o=L>( -5ZEIE8W>r!%&g`oJnG8,2bR*X25tBY[Pj%:kDs85R+WH"I)4P9Hm_FA;M4T!$/p!*+V5Q_WW(^=on: -^;nt7?J2:.lHX+qiE_?Z=19L\6i#bil*J/_]!dXlZ[gL%V,%: -X9'BXZl:1,f&>=$!MCP#?32SN!ht,Fi^*]50EJ!u[kD\Bf?bVE;W368:uu%2aXdEb=q\_;%!-"?6$4!\bQlPA78MeG_/WE%0M8m+<0=K*J9.i@b2+J-BAm%*!NH.,YqC9G!mT:!B!gWo@*h3`#Ya6*RU+% -_Bo<#-Ha7.6g2r!@HTVuar`kYN.cC:'Td9BnnK`f7JD*/Na+q<.d/=+K#9^W:[fC`dX^L9*Wb+>@Fu -T#ZlL7k.cKdtTKE7u!!.qJd=j&bBoZOg7N^tlZ"8E#,'P(oi.4HN*FZMuJ^bThVB1;g)M.f*J[PUG7 -o(;u-$>4J0HpM;I-dfs+8IL>NiF[2##KrV_us=dGs!'k^)ZgI*^T3VC>Aka$$$(i*(%(R6KfJf4!in -GNrU[gCB4JJ,\1H=QM*qkJ/]]*17s-gP/5N5J_%bQ`]\hW/LW/\k\>&Z`$E8"s4G5\` -UUYiTaW4&g"*$o&']n,46L!:TiUcBD6cqeF"dri#DlM8-2\f!QaRL -%a%[?11q*n.)q8m@JjLVoH.tX*oZ""U"15-g)U48*5U2F_8%*8\/R#[)h8DQqngT8,$>id)YjHISZ],6/dMU]Bk6"p&=S=!qU,Z2R_2Ieb)nVN[\JJ.r!-Wb3L -IC*E!tiT*"-i$*"H!5[VU#'p;@O9$N]<6J9YJ]o3e`#D#%)W3RrTI^0Z63:e^$D8=>4D8QcKe8EhFG -+rd,/bi2Xreoj0+m+iM(fsdj'A18*5R;gH"FaeWECi?N%mq``EW@8u,%7uKiRYJ^eh,87FDWW4F[7I/Q+]\FPE7=hgE$ -E/4=3,`l5l7 -`H^DSj1PQpdn/\to[f@S#J2:J=37K'/DdXuJTH7q)*/;DKr]J4NQlZ>E#`;=t@W1a9,KB=W/f]BEM8 -B1U61?7E\f\Pg,6?Do68=`J$63Q)+*#Z>^a-P-0^>^U"0@.X;8DF5g.hF0E]$Sn+<)>Pq?MOq*htD2 -O[pO-/E_\T+C19WTEM;*a2@/[XJ,(>@JN#&R4HD_a!OP4'>,WJXB4BW!O\^(qIfq>INDqiF47?7[;t -SReHL7#-shhtU%B?Wr+[D./>hJM$3VEH-NhaO.m7FaU.QL5*U469IShjAe;t`E&0E(Z!hTMq!VRS-/ -ge@i49-u6^^:-<>jk-Kd=;L4qE%Muh,".PUfIn"UMqsk(/!f)LPOdf8_,!Jp`DhLiX\6"?75ds`$5; -c,%8\TR1]Ro'$#MFUt%KdQ9S=QcW"J"j[UXqNiE-R]l/`+:>sVJWS/@ZITG9&TYaSoFHl`J5;9"%JCM=^Hu5RE2hbL"SAk=Maj*\-Fu"LZKgq -?3eC\.Se5MD-:UJ3]TAJ"K6h#_!iQ/K=fmBBTC!+4&r&_uPgR"9j=+(`IrI#^Pe6+",bZ%q#47i1&.jL;U\Fij^i0k$SYe]7Ga -iVuT'_>Q=fI(,[4a -LZf!DVhbD8e,2EA$jo$aX_9o=(kl35b92\u997%ECS:e(EX4O"!#S`;8i"a^.p1OM_\@^Cl(N/CeT@ -tahHEEZT.J1MHRe,V;i"!D*G)E5b^q=i@)thE31mS`a"?kHe*VHDS)oQ^BmWN77licg)tQN?e%QOZl_)j`M)5b\s -5N-'q$&AjO_>nm0*fMoEO!)l0%J.uraU$=HV&'@'Sj0Cr\X5Y]5fX7M?!]g]Sh^nq1&&jGHHRh?($.NXkP&4pRG`a:3-t+>l$8#I;1eUdEuMCOcKmW!X`IJlfJekY]m@p,te@Ht/ -l@5-kj+QP2,]=e?P7#p0,eL$8$Gj!4n6n3@>Spcfae?=+YYu$,@'!! -)U;3q<'lrgC5j4r!"![`MW:R*omM^[E8hoQ]1$A+%6$TPC_T5a0=MB,LCVnRmLu-C[r`\pDO#3.7sS -:lMqWH!!*Wb5=\6]+(M)QY4*J4LRItH#Rgd)@Ja``drZW?i=(5TB+.$-Lte#>7OZi\4l:7[!%dW"ha -^:;:^a,UL_Fp&e7>]?+ga;1\;/s0$sL^18'^Ga!00t.2:>?;)s%cYQQQE:=D<0B$nT#q34d&\WHFgo ->7,Bj/a#7dOsJ7W.Y/8_6-g4,-ptqFNkSm`9"5?^!(a"k/SKG19U'3=UinN@cp-j[!3a<4G(E7W8\Q -&>*M>rO%hKbOA:XO0:dBID,P-!g]44XYhb!qIh/kng9KoSC'N&G)]&9g<,)ucj?joZI -#\1KO9*%&![n$]h>i;OUPC7]#H5lI.%c$0.0,ID304KF\_r"]"IP&%MlABO,EBG4NjR:DYc,L3+J40 -t^*+Wc\JV#$hung3bm-gmLJW)J8-U^Y$'0lL%>Y=U5R3;L"c&9YLN-oe!!``_IuD_D%.JE?W[%S=D_ -3A^%OcW/d,I*+#r2dHV+?=idd&[:?T6Vc]DFXR@&/Z>qPD#9NSr\Q1.="@AZan@5G;YlU2,jAI/j;u -J.k0J#]Cn`URE;-!)&:aP6RT4"gD5:,5VP,nLuY\9>Jup`(SF`kd_>q`YdAiO2q?Yn-0,BS-LLgLEf -k#:jWGG$Q7k1#N1])#RE"i"c'X!LNifLLi\ttTE(>a!!!FXJU%6O!!e=MLRCSdMN\9u)$b*eQ]MJ1i -1Lu2N!u-oZH6L395]P)^aaB+Q3ph->5AL!H%6/$LS>P?ciM*WF,fg.#Pk5%n9CF9G6j:RPn8,BWu[' -XCOeLfY[@h_l?Sbe5R\NbT!@U>OtssD7Dr/U4SoF932@D=NCY/pM22?an-B8%.0ks8ZZ(,D\?H3PRg -1ucJ:OOTW-s28nUOQ9J3&o)JEmbl8u,kMLTh#uYR$$ZH:AHk7H$[jKU)k2r.he>Ro6>H;+lm_acs=* -&8:?o=H!^T[YOAs7a]::&nWl^et;0oQ2l9)3MK"5`$Snd$X'M1.-1G="ethVJI4$FF,UFCN=7jra:^ -:jJmV/Tc4d...mSLiLj9?#G9#gh&_O.>>FE$lM&b`(3LG/[R"#_N)@*2ERBQmNaF!u,Z&.]M%IiS=$ -SIC+9aXFKW4BWm=^/k,HP&Mi).B><\B14:N!rWj[@+Cu_nV5JnJ2E#WldpC;$OL+I^WYUTKtu7dqf` -h(D#I*!$[n_310bMH_TgrN!fiQo8Q#.r^],qbB]2mBu/)b%82k$(U/5/Wb>/sGaFeAMR[d6/Fo3rFH -P4#MMZY]YojfTV8.p%HTX+"N##XoPsKJOX'(7H_2p\s -`d@$;:]W#^i#2Rr!%8!N+9XU<"IAn3P@t+"Bf8K6_Pb!LY\\_/Zcnh0@*Y#&Sl?-GP>.!,_oP@OMlc -!*6AX'aq$Xe_n)H8LeR*mb>(m>U -9IFJOp\9Wco@!%:!G*2iO);t<:kberAd1'3+RBV)UYgp?>ploaaS=l\c;**6*b:7P2M+IcLH#rK%>aq>($3[rG? -(d!2?!87r[pC1D%MMQYC!.EBQD%3=dNP)eJkgqJ=98cu)$]kJ?+\rNqN=!EMb<7ic -%%EndData -end restore showpage -%%Trailer -%%EOF diff --git a/Documentation/images/cbuff-module_final_small.png b/Documentation/images/cbuff-module_final_small.png deleted file mode 100644 index d9dbf07..0000000 Binary files a/Documentation/images/cbuff-module_final_small.png and /dev/null differ diff --git a/Documentation/images/circular_addressing.PNG b/Documentation/images/circular_addressing.PNG deleted file mode 100644 index 432465e..0000000 Binary files a/Documentation/images/circular_addressing.PNG and /dev/null differ diff --git a/Documentation/images/diagrams.ppt b/Documentation/images/diagrams.ppt deleted file mode 100644 index 3c24aeb..0000000 Binary files a/Documentation/images/diagrams.ppt and /dev/null differ diff --git a/Documentation/images/modulo_addressing.PNG b/Documentation/images/modulo_addressing.PNG deleted file mode 100644 index 07dc31f..0000000 Binary files a/Documentation/images/modulo_addressing.PNG and /dev/null differ diff --git a/Documentation/index.html b/Documentation/index.html deleted file mode 100644 index 62b853c..0000000 --- a/Documentation/index.html +++ /dev/null @@ -1,104 +0,0 @@ - - - - - Intel HEX Class Module - A C++ Intel HEX Encoder/Decoder - - - -Intel HEX Class - A C++ Class for Decoding and Encoding -Intel HEX files
- -CBUFF-Module-Logo
- -
Table Of Contents
- - - -
Introduction to the Intel -HEX Class -Module
- -

The Intel HEX Class Module is designed to allow the -programmer to easily work with Intel HEX files. Using standard C++ -stream operators it is possible to decode a file into memory and then -to examine the entire content of the file much more easily than if the -original file was simply opened in a text editor.

- -

Additionally, again using a C++ stream operator, it -is possible to encode the current data in memory back into Intel HEX -format again straight to a file.

- -

Using this class it is also possible to:
-

- -
    - -
  • Generate Intel HEX files with your own content
  • -
  • Fill blank areas of an Intel HEX file with a desired value or -pattern
  • -
  • Merge two or more files together
  • -
  • Selectively merge parts of two or more files together
  • -
  • Check an Intel HEX file for correctness and integrity (correct -construction, checksums ok, etc.)
    -
  • -
- -

Key Software -Capabilities

- -
    - -
  • -

    Stream Intel HEX file content into class for -decoding

    -
  • -
  • Stream data stored in memory out from class in Intel HEX format -to a file
    -
  • -
  • -

    'Never give up' approach to decoding; warning -and error messages can be examined upon completion; as much as humanely -possible will have been decoded.

    -
  • -
  • Class contains no 'try' calls; will always return cleanly for -programmer to make decision how to proceed.
    -
  • -
  • -

    File sizes up to 4GB supported (system -dependent).

    -
  • -
  • All records as per the official Intel "Hexadecimal Object File -Format Specification, Revision A, January 6, 1988" supported
    -
  • -
- -Downloading the Intel Hex -Class Module -

A fully tested stable release is always available -under the downloads link on http://codinghead.github.com/.

- -

Online -Documentation for the Intel Hex Class Module -

- -

Documentation of the API for the Intel HEX Class -module can be -reviewed here: http://codinghead.github.com/intel-hex-class/documentation -or can be built from the git repository.
-

- -
-

Return to Intel HEX Class's -project home page.

- -Updated 14th January 2012 -
- \ No newline at end of file diff --git a/README b/README.md similarity index 90% rename from README rename to README.md index 39f0bda..91eb94b 100644 --- a/README +++ b/README.md @@ -23,8 +23,3 @@ Key Software Capabilities * Class contains no 'try' calls; will always return cleanly for programmer to make decision how to proceed. * File sizes up to 4GB supported (system dependent). * All records as per the official Intel "Hexadecimal Object File Format Specification, Revision A, January 6, 1988" supported - -Project Page ------------- - -For all current information, visit the project page at [codinghead.github.com/Intel-HEX-Class](http://codinghead.github.com/Intel-HEX-Class/). diff --git a/doxygen/Doxyfile b/doxygen/Doxyfile index 9032681..96595c7 100644 --- a/doxygen/Doxyfile +++ b/doxygen/Doxyfile @@ -1,90 +1,122 @@ -# Doxyfile 1.7.1 +# Doxyfile 1.8.13 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# 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 (" ") +# 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. +# 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 quotes) that should identify the project. +# 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 = "Intel Hex Encoder/Decoder Class" -# 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. +# 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 = "Encoder/Decoder for Intel Hex format files." + +# 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_NUMBER = +PROJECT_LOGO = /home/stuartc/sw-dev/Intel-HEX-Class/Documentation/images/intelhexclass.png -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# 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. +# 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 cause performance problems for the file system. +# 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. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# 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 (the default) 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. +# 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 (the default) 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 +# 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" "the" +# 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" \ @@ -99,8 +131,9 @@ ABBREVIATE_BRIEF = "The $name class" \ 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 +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = NO @@ -108,1332 +141,1992 @@ ALWAYS_DETAILED_SEC = NO # 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 then 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. +# 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 = NO -# If the FULL_PATH_NAMES tag is set to YES then 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. +# 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 = +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 include paths that -# are normally passed to the compiler using the -I flag. +# 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 = +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. +# 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 -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# 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 comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# 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 behaviour. -# 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 behaviour instead. +# 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 (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# 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. +# 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. +# 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 acts -# 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. +# 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 = +ALIASES = -# 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. +# 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 -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# 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 only. Doxygen will then generate output that is more tailored for -# 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. +# 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, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. 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 that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. +# 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 -EXTENSION_MAPPING = +# 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); v.s. -# func(std::string) {}). This also make the inheritance and collaboration +# 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 = YES # 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 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. +# 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 (the default) -# 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. +# 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 +# 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 -# Set the SUBGROUPING tag to YES (the default) 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. +# 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 TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So +# 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 +# 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 SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penality. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will rougly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 +# 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 and EXTRACT_STATIC tags are set to YES +# 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. +# 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 = YES -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# 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 = YES -# 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. +# 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. When 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 (the default) only methods in the interface are included. +# 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 = NO # 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. +# '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 of documented classes, files or namespaces. -# If set to NO (the default) 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. +# 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 = NO -# 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 (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# 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 = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. +# 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 (the default) these blocks will be appended to the -# function's detailed documentation block. +# 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 (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# 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 +# 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 = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# 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 SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# 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 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. +# 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 (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# 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 (the default) 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. +# 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 = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# 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 default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to 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 default) -# the group names will appear in their defined order. +# 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 default), the class list will be sorted only by class name, -# not including the namespace part. +# 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. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. SORT_BY_SCOPE_NAME = 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. +# 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 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 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 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 sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of 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 initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# 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 +# 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 -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# 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 is 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 is 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 , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. +# 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 = +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. The 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. +# 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. -LAYOUT_FILE = +CITE_BIB_FILES = #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# 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 by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# 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 WARN_IF_UNDOCUMENTED 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. +# 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 WARN_IF_DOC_ERROR 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. +# 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 abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# 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 -# 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) +# 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 stderr. +# 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 = +WARN_LOGFILE = #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be 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. +# 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 = "../intelhex_class/" # This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. 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. +# 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 pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 +# 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 = *.cpp \ - *.h + *.h -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# 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 +# 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 = +EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded +# 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/* +# 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 = +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 = +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). +# 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 = +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 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 = +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. -# Possible values are YES and NO. If left blank NO is used. +# 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 image that are included in the documentation (see -# the \image command). +# 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 = ../Documentation/images # 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. +# 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 = +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 -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. +# 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 = +FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# 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 +# 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 also -# VERBATIM_HEADERS is set to NO. +# 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 and classes directly in the documentation. +# 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 = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. +# 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. +# 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. +# 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 (the default) -# 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. +# 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 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. +# 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 to YES (the default) 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. +# 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 = YES +# 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 +# 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. +# 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 -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) +# 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 one or more prefixes that -# should be ignored while generating the index headers. +# 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 = +IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate 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. If left blank `html' will be used as the default path. +# 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). If it is left blank -# doxygen will generate files with .html extension. +# 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 personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# 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. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -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 the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the stylesheet 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. -# The allowed range is 0 to 359. +# +# 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. +# 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. +# 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 NO can help when comparing the output of multiple runs. +# 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_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = 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. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO -# 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, 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 +# 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 -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# 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. +# 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" -# When GENERATE_DOCSET tag is set to YES, 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. +# 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 -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# 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 GENERATE_PUBLISHER_NAME tag identifies the documentation 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, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# 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 -# If the GENERATE_HTMLHELP tag is set to YES, 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 +# 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 = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, 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 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 = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, 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 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 -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# 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 = +CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, 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. +# 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 contents of the HTML help documentation and to the tree view. +# 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. +# 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. +# 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 = +QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace +# 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 -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# 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 QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# 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 = +QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. +# 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 = +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. +# 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 = +QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, 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. +# 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 = +QHG_LOCATION = -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, 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. +# 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. +# 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 -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. +# 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 -# This tag can be used to set the number of enum values (range [1..20]) -# that doxygen will group on one line in the generated HTML documentation. - -ENUM_VALUES_PER_LINE = 4 - # 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. +# 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 = NO -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. +# 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. -USE_INLINE_TREES = NO +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. +# 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 -# When 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. +# 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. The default is 10. Note that -# 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. +# 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 before the changes have effect. +# 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 -# 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. +# 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 +# , /