From 1be8db2f955242767a4f96e58ab3891f0109a811 Mon Sep 17 00:00:00 2001 From: Fernando Pelliccioni Date: Mon, 2 May 2016 11:54:58 -0300 Subject: [PATCH 001/199] Readme tests --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e2e5747..fa9b78e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Tao.Algorithm [![Travis Build Status](https://travis-ci.org/tao-cpp/algorithm.svg?branch=master)](https://travis-ci.org/tao-cpp/algorithm) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master)](https://ci.appveyor.com/project/fpelliccioni/algorithm) [![Code Climate](https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg)](https://codeclimate.com/github/tao-cpp/algorithm) -![Try it online][badge.wandbox] + ![Gitter Chat][badge.Gitter] > C++11/14/17 Algorithms Library From a554abe4f5d81729a9067ee852f9b333ba29d008 Mon Sep 17 00:00:00 2001 From: Fernando Pelliccioni Date: Mon, 2 May 2016 12:00:51 -0300 Subject: [PATCH 002/199] Readme tests --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fa9b78e..53e4b0e 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,12 @@ Tao.Algorithm [![Travis Build Status](https://travis-ci.org/tao-cpp/algorithm.svg?branch=master)](https://travis-ci.org/tao-cpp/algorithm) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master)](https://ci.appveyor.com/project/fpelliccioni/algorithm) [![Code Climate](https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg)](https://codeclimate.com/github/tao-cpp/algorithm) - +![GitHub version][https://badge.fury.io/gh/tao-cpp%2Falgorithm.svg] +![Travis Build Status][https://travis-ci.org/tao-cpp/algorithm.svg?branch=master] +![Appveyor Build Status][https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master] +![Code Climate][https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg] ![Gitter Chat][badge.Gitter] + > C++11/14/17 Algorithms Library From bb63c4a0660b5335e289ea802c5e5f14b52ad4e6 Mon Sep 17 00:00:00 2001 From: Fernando Pelliccioni Date: Mon, 2 May 2016 12:01:51 -0300 Subject: [PATCH 003/199] Readme tests --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 53e4b0e..7b07599 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,10 @@ Tao.Algorithm [![Travis Build Status](https://travis-ci.org/tao-cpp/algorithm.svg?branch=master)](https://travis-ci.org/tao-cpp/algorithm) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master)](https://ci.appveyor.com/project/fpelliccioni/algorithm) [![Code Climate](https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg)](https://codeclimate.com/github/tao-cpp/algorithm) -![GitHub version][https://badge.fury.io/gh/tao-cpp%2Falgorithm.svg] -![Travis Build Status][https://travis-ci.org/tao-cpp/algorithm.svg?branch=master] -![Appveyor Build Status][https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master] -![Code Climate][https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg] +![GitHub version]https://badge.fury.io/gh/tao-cpp%2Falgorithm.svg +![Travis Build Status]https://travis-ci.org/tao-cpp/algorithm.svg?branch=master +![Appveyor Build Status]https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master +![Code Climate]https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg ![Gitter Chat][badge.Gitter] From 168aace1fd89a3910c1f7a13f402134cfd8fd454 Mon Sep 17 00:00:00 2001 From: Fernando Pelliccioni Date: Mon, 2 May 2016 12:04:51 -0300 Subject: [PATCH 004/199] Readme tests --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7b07599..3331d99 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,16 @@ Tao.Algorithm [![Travis Build Status](https://travis-ci.org/tao-cpp/algorithm.svg?branch=master)](https://travis-ci.org/tao-cpp/algorithm) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master)](https://ci.appveyor.com/project/fpelliccioni/algorithm) [![Code Climate](https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg)](https://codeclimate.com/github/tao-cpp/algorithm) -![GitHub version]https://badge.fury.io/gh/tao-cpp%2Falgorithm.svg -![Travis Build Status]https://travis-ci.org/tao-cpp/algorithm.svg?branch=master -![Appveyor Build Status]https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master -![Code Climate]https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg +![GitHub version][badge.Version] +![Travis Build Status][badge.Travis] +![Appveyor Build Status][badge.Appveyor] +![Code Climate][badge.Codeclimate] ![Gitter Chat][badge.Gitter] + + + > C++11/14/17 Algorithms Library @@ -49,6 +52,11 @@ Please see [LICENSE.md](LICENSE.md). + +[badge.Version]: https://badge.fury.io/gh/tao-cpp%2Falgorithm.svg +[badge.Travis]: https://travis-ci.org/tao-cpp/algorithm.svg?branch=master +[badge.Appveyor]: https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master +[badge.Codeclimate]: https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg [badge.Gitter]: https://img.shields.io/badge/gitter-join%20chat-blue.svg [badge.Wandbox]: https://img.shields.io/badge/try%20it-online-blue.svg [C++Now]: http://cppnow.org From 952265107998834fcc276202bd55026fbe1d555b Mon Sep 17 00:00:00 2001 From: Fernando Pelliccioni Date: Mon, 2 May 2016 12:05:52 -0300 Subject: [PATCH 005/199] Readme tests --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3331d99..5dc46b5 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,17 @@ Tao.Algorithm ============= -[![GitHub version](https://badge.fury.io/gh/tao-cpp%2Falgorithm.svg)](https://badge.fury.io/gh/tao-cpp%2Falgorithm) -[![Travis Build Status](https://travis-ci.org/tao-cpp/algorithm.svg?branch=master)](https://travis-ci.org/tao-cpp/algorithm) -[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/tao-cpp/algorithm?svg=true&branch=master)](https://ci.appveyor.com/project/fpelliccioni/algorithm) -[![Code Climate](https://codeclimate.com/github/tao-cpp/algorithm/badges/gpa.svg)](https://codeclimate.com/github/tao-cpp/algorithm) ![GitHub version][badge.Version] ![Travis Build Status][badge.Travis] ![Appveyor Build Status][badge.Appveyor] ![Code Climate][badge.Codeclimate] ![Gitter Chat][badge.Gitter] - - - + > C++11/14/17 Algorithms Library From 98a9a35ba82f9b73433ae29bd93d164c8d806694 Mon Sep 17 00:00:00 2001 From: Fernando Pelliccioni Date: Mon, 2 May 2016 12:17:13 -0300 Subject: [PATCH 006/199] appveyor tests --- .appveyor.yml | 58 +++++++-------------------------------------------- 1 file changed, 7 insertions(+), 51 deletions(-) diff --git a/.appveyor.yml b/.appveyor.yml index 1d22e31..250e9ac 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -1,3 +1,4 @@ +# Tao.Algorithm # Copyright Fernando Pelliccioni 2016 # Distributed under the Boost Software License, Version 1.0. # (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt) @@ -17,60 +18,15 @@ build: configuration: - Debug + - Release branches: - except: - - /pr\/.+/ - -environment: - matrix: - - TESTS_ONLY: true - - EXAMPLES_ONLY: true - - -install: - ############################################################################ - # All external dependencies are installed in C:\projects\deps - ############################################################################ - - mkdir C:\projects\deps - - cd C:\projects\deps - - ############################################################################ - # Install Ninja - ############################################################################ - - set NINJA_URL="https://github.com/ninja-build/ninja/releases/download/v1.6.0/ninja-win.zip" - - appveyor DownloadFile %NINJA_URL% -FileName ninja.zip - - 7z x ninja.zip -oC:\projects\deps\ninja > nul - - set PATH=C:\projects\deps\ninja;%PATH% - - ninja --version - - ############################################################################ - # Install a recent CMake - ############################################################################ - - set CMAKE_URL="https://cmake.org/files/v3.4/cmake-3.4.0-win32-x86.zip" - - appveyor DownloadFile %CMAKE_URL% -FileName cmake.zip - - 7z x cmake.zip -oC:\projects\deps\cmake > nul - - set PATH=C:\projects\deps\cmake\bin;%PATH% - - cmake --version - - ############################################################################ - # Install a pre-built Clang-cl - ############################################################################ - - set LLVM_URL="https://www.dropbox.com/s/caol8ihddfwqs31/LLVM-3.7.0-win64.zip?dl=1" - - appveyor DownloadFile %LLVM_URL% -FileName llvm.zip - - 7z x llvm.zip -oC:\projects\deps\llvm > nul - - set PATH=C:\projects\deps\llvm\bin;%PATH% - - clang-cl -v - - -before_build: - - call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64 - - cd C:\projects\algorithm - + only: + - master + # - develop build_script: - mkdir build - cd build - - cmake .. -GNinja -DCMAKE_CXX_COMPILER=clang-cl -DCMAKE_CXX_FLAGS="-fms-compatibility-version=19" - - if "%TESTS_ONLY%" == "true" (ninja tests && ctest -R --output-on-failure "test.+") - - if "%EXAMPLES_ONLY%" == "true" (ninja examples && ctest -R --output-on-failure "example.+") + - cmake .. + - cmake --build . --config %CONFIG% \ No newline at end of file From fa2e174dc0cf79663df602e03973684d2c6c6c28 Mon Sep 17 00:00:00 2001 From: Fernando Pelliccioni Date: Mon, 2 May 2016 12:29:25 -0300 Subject: [PATCH 007/199] Readme tests --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5dc46b5..9760e05 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ Tao.Algorithm ![GitHub version][badge.Version] ![Travis Build Status][badge.Travis] ![Appveyor Build Status][badge.Appveyor] -![Code Climate][badge.Codeclimate] ![Gitter Chat][badge.Gitter] + + Tao.Algorithm + + + + + + + + + + + + +
+ + +
+

Tao.Algorithm is a C++11/14/17 ... —see it on Github—.

+
+ + +
+
+ +

Requirements

+
+

The library requires a standard conformant implementation of C++11; a few additional features are only available under C++14. Some effort was done to support incomplete language or standard library implementations —see Config—. There are no external dependencies.

+ +

The library was successfully tested with the following configurations [*]:

+
    +
  • Clang 3.3, 3.4 (both with libc++ and libstdc++)
  • +
  • GCC 4.8, 4.9
  • +
  • MSVC 2013
  • +
+

[*] Only Clang with libc++ implement enough functionality to support every feature of the library.

+
+
+ +
+

+ Copyright + Fernando Pelliccioni, + 2016 +

+ +

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+ + diff --git a/docs/logo.png b/docs/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..0d6a6b43dcc471434f7dfbb025708625e099ff1c GIT binary patch literal 14553 zcmX9l1z3~c*KBkM8JrKE%L8mwt|siI+$1{^-3BDymCV28dgh5k-D~S^9#{?qs7<4J>s6TLXvdg4Tjw|%|G`y zG&5LVX~etz2)~ZzmdRiR(OJhiH8$09M!fn-&?fE2W#0HK|B3U{gDJn!IZ^+=M3^kljj@}KgN;g37R!1b~_2515 z1HX6%N^AuAzCX=L>Blqw;+d|oF^^@6xCp1_ky7P0ld2%&9~%0aC$Tmt8`t_1WF6Vj#6C;5vBWrfujY{+vwcbFOZsy=abTVe)2DEph&{z1VUb$7q~*uY6a@~>3`Vl)BI1BE_nVI&C=6<4mI`)HJX9$GPEJ!_L+V1rteaxc)W{->v@E5y?Slvih z`RSig(Fgdv$!YMeHH4{KwknaxYv;4PkTj79VVd;*_o;pNWMQI(N1(grT{bihSi8++BIAa2@&XMPow025}w#p7F<9Fbp4Uoe(L- zRT9KWR!!!_rOpbsr4O*NDY$-EOf$S%-`p^AZ;@X6QTfa63zSOZ9y`SxQTs`KKXUgqHQi4r(S~@2xSTG`Vv(;| z=uN44Zd2H_Xw|VH$!nKtDMd%OOv{i;Jg6)8y$w}xsrRWh^;{F4YhltBzm!;{%Y2D& z6?+7oP-LA`_;Tzb4P~888W32}NHMV~UPBR9F@pjh&C4V$=1tD1ld#CA(=_rg&QA-z zG@Pi>R~D^@Ra0JQPck~7cUz$=C|aW6lve55{P4kzz3!d##F;yQd>wp!x+?A8q##Aw zK^b?JOt=1;ggg5ta_=W(YvcMOxCs0ZgQ;Y^LUp|6NIOQzQAt&VhDY!F^V^b96`X>d zMhDnrQ6e=yWvW%#qbzi(2k(-3V?&ZlH`yD1jz!8^(VrW~!k55A%d^w$&eF9t@Lfr+ zK*k0E=;tgL@hM(*Yi{}c7EDiNhCV`&Lj6P=w;mz1Z72?9<)fcR#=>Vt@ECbp`2g!F zbz~V<*`I3q7Q*Lx(VzFBA)szrtDgqJ*ErE?WGw=)Wr|vZIUXU}i`;S2zXAVp2QRGY zttVjgH!YuwNjI3RU)$e_wcMdIe*Sy>4b3s=ob|yUfh1Px{aBQ_9L?cby7+G&*V2E=oUw~C>DsQ! zqZ|>2-@i<$iSMrBVW!unfAXKP3p44?xU!KL5lsG)VPCqZ*(M(qe`P&1c=KX+vLTvD zH)ll~brnkcR`_cEEWC%s*O*W%z}kVP^k|pemK9`o30_O)8aT)M`otgCQ%?sDHwp{k z$Bsor0b)Wr*mfQx$D65_%6`jA22c;K!klP!T=Mdc&%OjHt7E6%1re3iEmS&O}zGlfQ8`S9E-33z+K5)4gAn+ zBt;+g^e!6p9+@8TGY};KtzG6NzXpB`%{2ETI21TqQZ98HwhTP4`*G!X|BUHTdGiLi z>k)E*1uS3woBr4oC0BK^uu+M`bPn&*F2hQkQ?VdKsjcYFO?KIL6&j(166>qoZ)CWV zBUU}8o*;|T=!Gl((1(IfiXd?TKF$xUB)Lvf^)bzmpa$xz#akkuyzy2}j4dbz63aQf zO}h*!??l_8E2=Bh%b7sE1Y*fnhi{HG| zkF?E;Y?xw%aWuuZcG*`H8Wm9oTNB6oqrjTK>a4iDX3)CD--K_BMH|^D<1pQ{hg``@ zgV(%_9g+;_13_Q40-4bX9UQ3!f`KCE@OtesQrc4H{wvQ+5Oqx~|A8t>zn;c5J5kGDf$Lu?RGXQb+$3ic@bU<44XRKI;RVRcf+ow_T5QXizHupxtNy5qI>LAT@rYh{iUC{i)fe(&};~LSdgPND%cO%Es2pihW z7DJMeeuU0(lTJj)R1p>ZvtB9a;S4|Al#OhP zXu5YHko9XofwQ6FI=-EoLdOWO&6%t)#nk%iI=cJL--Q1(`**H(sGh^i00KSF(p-dj zpR?`a`z}6j`N1IPGdk~>%9+5QSq(- z*ZPy5;vMk7P#Y?`tL0Xywl)15-8Qztnm;WbnkM*o;_-DJ6lh(Lo>7nUO1XC3& zylZc_7-={BUqv_=R_o*yQS%txiN03j{@s=DYQjpXV+uCo8iDj8BSIqctx{3sYc>a? zwm?m~9epyh1c5j%T?Ea{!r_0|q?~KZM3FBhv%XS;HJpk0hGpdgK(A&lH2v!r zMCYlLn3)#pQ@US0_@AF0oT~XSj!i;4fFQGa@8WOWtO|!3NdC-UfA^4i-Nm;e=Xv0R zI%aNDh`|Vbqvqiw%c+$US|UMuM2r3m{@kHy<;o%>7P(n;^UyWOpPSsY8;#j!$S4UB z4>XM0bnCsj)Ad^X4L9y>DEQQ(fitI^dmH{By_Cp|KB>}i5ugAt0XmO+yntM=kf~x&?iM-Tb zlODR{Cp)&ute?p=BrcK$iSDY1;I5A(tgU|-AA!1px`UEIp>?{Tb?PGO18~O8L#>B{ z4n=8)aOqd7jX@HfgI$)t21f8^n7^3iWfSYK3`8oTC;k^phs2}u#bcICMmR@F;eS#v z2JL*IM9O%1gThrxACt%Y9Z;C%`Cj%$N+$HQ@dAM@NL8R6Bs7a$`fVhq9G6ZRw^-Zg z6L{%obzi674NUU1L~zffduO2-x@)(n&UGSI9ZVYcHeuUwXW>~*0||s|2zxu#({11y zB_#_cQKVC+mVJ8#e{@%yT_OB^`}}xc)E)4wtw{l&l&K0UBN)%O5oOq95opbIEXlp* z1iuzn<36l;ynoR>#T##W=v&0KoBZQPr$1Nn`6TT{Y~_lh4fE`$0rgRZ=Ftkmd}fVrH*bgnA24x zLcRMEzSjrMB7LW%_Cu>~|4P#(e6;1LC?k;E%d&+9a_UE0`r|z%ql^dj0*5Oa3Ewvs zw{Mqi2xfqEK4LmpSmN0lf>1L{n5C*bBPTD}Ik(Vz%D+0cijhy9!0EkgHc;C}slc3Y z4qfuC-X#ksu-?h@9B(Z=#oi59A^G>qcyGL;G*@f|bA;CCOjSl_yDggEKaJ!LJ zBz-h877QgHELXEvL!%XiY!X;T{VUpOsDB_Q; zP+^yGL7?bzfEfFe($^p-rvb{GD`a(C52l@N+#A0j&GmORu<~+6W74Y%tF@Tkw8wq5 zXpgT*X*Mqu{QD3+$+?wDmy!pnO`fWo{rg_w`dT)x;0mQo!Ns_&t>W2RP{vAkI(PDU zkRpFpe{{(yr{>*KnxaA%`N-!1K10XUEy}#+YJp|p98gF)&F@1~==RIzGyBv(^3&To z$MN>EcCtMJid-`VUQBRZ*y=SDAAe@E^28TRGxbOugGMF*rzJTYOdBFYDhTIbjOK1z zfHUG4Rx$h05|h?B$?N0zb?`_Djj54hZpRlqgnZf>4wia10|(*I3RH8zq$@K0!52vI z@`Fvf^d36aoIh@%rb8O-U*VXntRJz4=OL(AE&3=4@QhT61a%>8&R@E=EBy}1sE5F= zZ)mpd9q5kk?OThcv`}?z71Ov?M7(A#;;{M6VP*4NF|rUUvt2SE@Hwl8qc$iJX%$Od z$o=syPx87gVg9MPCVfY?i#*i4glu}rodTH8%H%RPlndSd$~!n|65k|)eq}NG9QmK3 zh*P@p0We1)LgJFehe33)1}90jWS5{(Y<{Ihmd4artyp`qt(#o1UVL+SEee>VBS;Fq zsDJiTwxkr?!YX?z1>1e9QuP6jc_1}cmv9ZRb5r-CeYL}Ro%(}yd;h|!Toc5Q2UaB0 zXQ<)NHr4twi}l~XZ4y3))Er2cI7?_uZc1%5nZHU_`sQZE<-W2VHz6%$v~4xZX?&=Yhn1qilV$M#{!W@&Y0Cx8vrEJ4p9-{oJ=r zV-|N>j$}??e8=Xq3I$>0c_HPJQvR8e^K0V~U{1M{+g2}dWV+owwjBkN~qeb5NXG>aq$bEWTVZb$E!g$npB6WS+c*GU3 zN%MO6fR3kLlaW~g1AJ1Y>`$KNKN!FAXJA+GJEbtHr1lYI?2l64`qsiF{)5P~Z^ha; zE4Mgf%w5JK?$btBCwEn53cKGV5TE9vN-ie;*zMfoN`C7CQZ)N1eB?gIiM|ZUP@s$B zIk<1&#~v+l8!Utu`|f#lD+#Y_vj}xpe3)0y(Qm8q_=2$Nh5{ilCiAt_B4bwHC88lQ za3A5L&M|U_It$4kTe9)A{Y9UxMuupN-PspDXZ~rwyJSGt-PlaDEIHW`>5^qnzwiF;nRf)MFkB1 zaXe~-Phn;0$;JgD_u02c+PLS0G`_yjncsQ%)r<;dvw-jjiQ5*gm~PNF>cYyi*+ObH zQ0~1q&#}n*icZdrMvmn@sljV&Vrw$T@n2-3L%GzhdmM#X=rbWGPQufj4ZHx=A{ww@rj2u+B zo8j1vCEnRi`9fY&*GD%KiD`j9JVaP+&%)c`)yqP7^&KUWFn*CR<14=|%N3-O&r?s+ zY^M=UB~F{OOE*8WvXmQf#!4BGv6zGU!irka*9cz=?-6)QxiRGGS4l{RmciEq75AGd z3Ql!pPnbNz=F!QX!nJ5tbp_}UynrX!Qzkb$(bd&W?^^exZW(g>I2;7QrCuxI5ts3P z9+Bu20SOFZj<;SpQX*l2iv-HA1m0#|$g)aaucFRyP9IylJo8^OaIB#GUqVVJJW|%9 z@aY)$_ilwI@&9~QQP;3uffd!-nHB!)Ut{UonuofjhNAe6>;DJqv)(wtfrQc3wE@9_s|;+JadX}6EwJqU*a z_%<;v+h>k={~A>e@rf3ZE{arS-cFH$LOTWChs=4AS&C<0a(i~2{Xavzt0Q3l&4d~G z3gn)@Z}iS|^7{U$|E?g3Yr5AMff%LP^0l1#n7^(M&R9xg@>~p|UI&gYG*eOJ^-)q9 z*Ti3N2Bi+ueR+mVPYeZo1BB9dbX2KL0NH_+AiqMEx70ZB5he-#Z^R9bvbgB>jv{g{{sgR!uLg$0L$jJNNwV_Fm7>wp{dS9NBvS+s#d=WPzwMg&G-_OzFIQ9@=@9oHoWR(?l?EkC#W%s?Pxt z5sqbpYVpo4V{`KQB4#kaS6XQ3y|Q_?BLsqueJNLaS0kKNBhDoF9dba9%JiqHHh{hM zA$xTkupR8TH)Xwpww6iOTTWr98b*{yN$evKh>M~3n&p3Xc>>OhW0L&q@bX?;w*@?7 zwO}ST%N~B$6#9~T!V!?nSBvYJ^he_fkM+C9No}4(x3+g zqkH}eJ2R#B3FIKjCWr(|3NliT$_lz-<-Rc*ESRHEMD^5sS@!8R#;D`z1xS!m7GAxz zY=!^5+be#{;dL67ONrPl>+i7>x5+FEqIb!%rM7tUsk{<>MCCK6nYiGM154Mk|K9Vf z4+6}9(Bsk)%LQ2KGFUGxE?J^tQW*`pYN?FDEx-QB&0Uac;#cgYtx@GEDN9c0+&L&Q za0+FN81@`IXGd^Pd}5hpA1qAy{%IAjxM+aIR{Fk^@i*@e)+Xjw^#R|fp5rI}A!#uA zU#Q|%$@(k203;(r_siWReujDQ&K?lVA(@;&(_5!EDJ$0m@*w1tH<-H|hK4`AS&1N2 z>c4X$Wy6{`b5MGo>!*|JD`FrkH1ui{f2$gV!)AR@I&6$5&r6ex07klVkQ7y7^RZmc zUsq}dv_DtBLa%oI+uP<&|D6TP$^vIAzqNq zHDp1&P1O6R2OOkvq)segf-n;LtQ-m)O?<~!1Ka-*p%`6d`dhAK6>Ju#IcZsm<)Nad zq6CfWAVf`9qvAH~HNH8XN1{!1#XncSvjKIE!yyn{Uh4KqSpb=3?CUkvA>+zVz#6c1 zgaj1Ikq~r4>sQEKZ~8?#I$e!OFZX=po9pNl^py@k`MrCfwbq8=6Zz|W<;?3Lmg>(# zi}5&o{$kRG&KkrKV~;}dHUIEH8YGZdPszk0L(&gUaI@vlt+6oTvE zrQ6-S;~5~g@}(iV z9168<6$a)iVkA1VOyw^-0*-s|Iu46$sr}4WD_~Q7TD;>MDR3Sx~Mj{rT8qf#=aBnQ97D^q^=E`!xXZ zA8!re4R)xqy-35Hzx3@{(JHXe5-ifr%1>fmNbKclGBPIw#Ebgi9?QMpa{(7p{VJKO z7fh7(eUK196>$9G3Y1purBES1e7ILd8IshaK@6$ImaufJ6sBXjrbuBZ1gb2#>igG= z#K$&}zoM|e`B~=eM4;|j7vy6_s|DLY zh42s!l2GkP3KpqM*X;Vn29aL~P$?A&ITp4;9MQ{vNCa^~YQ6!>o`my2+1>;7qz?^U z7a~_jtuwO4ZZu z;y>fHRWDw^0r}_ns_?j}JLabhQn``457(6}bwH4sAG*YL8^{eRxF9QQ2h@TqaCp4XXxR#?~sfR}pzq*EAdh=u9M5sy~tH`L7f zRryI+uElM<0ib}YVWpO$86GXv%3$WuH7Te;1gkn5f$caWKpJY2e|L8@*b-1Z7o?e<9@qYbrSHH4~#o*e|8UUwS5To{* z{Obj{rU7p_rPld#;~ldNWNb?wdh%P5m{Bd5qT;D(#oUgXQJyd*lCjQS^x~qWxmaZR zIZMnCoN=gba6`G!EV}zqnNh2~Xihp788uEDw_E)1`{)1N+eH_T#r|ok`9*ezAHY}B zuYiw!U`gh}m2dRz#RI+<;y?HNKZNOkWiOOopTZcOm4WmXz-4ho)1y^8IB^a(+<9LC z&%m=p8M6uLR$<~RL|H(g-qEz%y-j^^$WTY_<{kBWCo7E000sjk=~!(29Ht&{jPqL^ z98;xB*y-bJk8bEzV&mu>wu&FR*%|fU@hpK_SPouTm~fJJ0wUW@cu%;w0g)= zrBm@lNd{MC_a_7Dm}y%NmWTjQg4nX3W?Y?ey+9HlF*9r7 zvSBna6NmPP-)JZe=UDLpUCqS4L+N;yq+m{=!Xi{Ve9lf#X#Qb0USnUh?`tQGxH&tw z8H4lth2|e22t-qWG)WE^xLeI;C0Bw|Gcd2X43WwR#+(8^ky;PnF0M1e_|CQ=6Oqh< zj!p?uDMK(aJve0DpD{&k4z>XV{sK0(N^B$V>9v7ZnZ7fJheI z?u^hr&N_@Wsk#Eq)T%K0|kxQZzO$? zGCDmjBiwa$zUy<$KY&VH5p*_R;1B}`iLmZq(+$SvaSc!Er%>Slo#My3l@2^qRY2fT z(^e?`h|`DHtic>szR^{M%^KTB^L9Rc(&uQu%~;1Zanx}3!vTVW+S3%R6+aZ+OH@Bc z!bt*?2Swh`A|O(Q7<};YgmMki|9re4HfsCY!4BA;N%l*u889Y>=Ldx3;*U@Ex_ih4 zaFDXly$5hGdDV=-pUh>pVdZ|us=r|Gw^rwF-}_pi{4l0Q?(VC`s^z#is@#8hG-p6&HP02a$N6o768P_tP`37xF1Sp<~t&Ww)0u^<$xOTHf170$u&YCH3|f)lGb zwhNv%SfSMg8W(hS_%>qSnM2Hc^@;_q9mLQ?D6NoTA)8i+;mvNmAAq2&aKDE|jnS2U zPGS>&^)c)?96)hJW1mKpC*I^|Mu7HlNO-5HvkgMDf{ywPsr!4immF-T``#-cz&v2w z`RT`{dXWRCWQRRG%{q(XYo~E;)k~3hXyzBXbO$lK1>UEr6f3jOY@B_PXBw@GVEP_( zrf@^LASE#X4hvp8aVD1GmHt6!GW@Zl>k_U-@~r?uWb#AO^Eoq%L9bs>C~cP4eG>!Y zm(EesVljW(%?bcBfj_z?(X|&`j$EJS)H`M|s*cwbPNhmed8|LW=D09$rZ9JQk;93$hV8g>|_6 zSUSPmXUCUxc{OZUjSnx}-s%S%N_~WRzYn zQO)taJoNg|;3uq(g+D#&>Bp+bz=(@^c>{${pCynKIFdKou6E3PZWUZc90iXW^^MpN znPS*E;_JU(-n18@K+CY{j<0;xcrzfy8*)H5lDhhZ2q8)WB3vwkIy1JNgQRjk=iKP4 zVHcWm?OI}BuRVNCEHfvJI7o=dU!+g!nxrkl_?K1gYM-@sy3DA*n58>VqRBG|>E#8| zPnn6g@XjPHb;}eZ=}5!trug_mnJ8Crt16{U%W|N^QM;R)gDj`JS1}wRa&aqZ`!>jA zWbrs4KsO-f&7ZZO&C<*MGFoAyMxs(ecrCKlRTU1(%>)@BYj!?ocdrqB(b(oc;mM(H zP--ABhq1etg8yWE22IMoJQB%G@vB2Sf1AB++i-dL-ayw%UM_Mzy_fRrli@`OMH(09 z-xm+hy>Y!!u_E|#2>*Qn*o!LUqThot+3&F^FR?YSV1K8J8^2c1zgg$D!7}b2OCBzL z#Kn0h^_8=>2~rZYF9y+X^=4MCl9vYDGaP;VpQkbkIh5S;EX@q~`bTA5QImUr3#X}x zru>!*o_CDqbf38VaOu+|kZgPFqT8e#b=yIanooG$Ff-g3AAg#2jqP=3Qd5Ey+PY$htE}S7x1mr zBh%n>iREv+Nna#7Igtc&ApJV!yH8`d0k`=()C?nPmUjyo5AHDnKFIZl^b|?M5Eo}3 zF{k+c__-XZy_$eGZ^hFJYZe|(Xj;>2=4!J+>k5$Rf+ABjLeZrh_4z>JbTs^P1nw;x z-8WD;ZB8uf{d0v(_vk2zCz(JxUGmvC;16!Dkw2XycTH{c)6BZG*Qota*S~Cg2dCtv zg#%-=>hbT3bqME*IKlQR(M(8q zNU!j{_@+{eGoG|et^87qriXiUw?Xs>P$RL&>a_D`Xdh|>nxbZ4_^Lajx|PE2f-159 ziauXGJTA`8V#NoH76nW9r<#`Z2Jdg_l7ogB zsq$J-jB-EV)!G92_2J>)aZh0cI0g*o&)X;WmK^a?80JN6e$!5Q-D;}vJ*r&;QoUDw z263s;Xrm6N`QVB$ki>;pEuh(`HslM0QQF=*;T<5iRF8~gXEl=U#eIqB_$%+3kBv|> zkI@Mhqq?GQ1wffgX71Ev_7YGl*>FK+hI1@V54^V3PvaviUHz<}3Za7a#Q(}tajp0t zYrz0(EAx!#JSb$%1Dg9TF;S=)KBB(V8kFM)|L_;Aha#yqoP+jG%k-?lsb-jq82%=T zX>v*FJ^IF(1t-Y&7sr0Uymw!5P~FwYL8;?_Z{>YDc=Ui(yi!x(8e;>EI$dFEYd4G- zUj451`2D}?+SweyfzMbI@&--1_!VnRlZ8f)|9Od^P0MB45+A+)mU(~zPv+Jrmzd%( zAQN@^2s}KgRv?{qi8u6p7aswjLFyd{|LWMe#ZbwK?)r+|y`Sl?NJ}k|8J-^rovX6N zkq-{5PM7da82pLXI**7EMk`tZ*IX{^TU9qWKZ^1bLK5_f%!y^ngHXq=>@`)|e&K3Z=i? zop!+Y1@pDgX6f_bDWlrw2wIzdfDetFWG#Fj#5py(|DzJnvIHBq4*~7p_i!Ki8K)be z>%5njn`JE+D0EI=V6{>(eEQ`38HBQ1)XKn`bH#*@NkcEfU1T-4AdBEd)IDQ|jrB2m z5!zIY2jcD5rG#(kG!FR7^qO?7-_toxs`LYs#LwxA^;X6V7c*-ygpXc}b8rQqYoNSF zRZcbb5h=NwJ=7T@68*HaD<;7DXZCj!e0=n}l&P1$s?m+v2FxoR8OnNGjls|^b;lzL zsM@aMkzIAwX5d+Cq|*vr2<1l5eNa8;B7?}0k%^(deXrxI4%a9#ErW^t z9(km3RSpz)dr1GY>V;G2zGG37@KQh+t;(lsh@Akt)}V+IJhyZNK_XP=x@WNz9@jh1J4Lw1YLDUPw9>B{sR%Dl?#cxHVOeH9q-*GM_JNMr zvZ@QWG3Dt5(?3&_>5g~!v2PIe_UVGvH(RWkYPZju3gnW-#1#$WC1t!kfo2W}i>cbx z-Uo?I(^`QOsXsL6NgOn|oLnTiiHTDevz-|F&4G^qRX6V*=pq>;vVix*&ivMeRXobE zqWgu%r3>zgd)gIv_v!ZPxOd;pxVC-m5l!o1XUun}S5#5HGBS5FTh$t}NO~F{06QVo zmR%EfCgmy%T3i@5%>H%J=rAp^7C_qqMZfA?+r)Eyac%V4L$x&vlvei?kU^IJ&~4)` z74lr+@pZHeV}RwDwHJP-1d#K)n8IXcWZTa$5YR8T@_2>MJh7kR|1U z!{fv!9JoJz$?@c$=}+yQQZkvfUi_h77V*log4CEbYyNO&IQ$`tgAsWxDL2m`g?31U zs2go9E;Sr{pq=#_oqv~O5c1$YO64Z9UNS^DL>uFy-=rgyRU{%>29Ac4j7|6ffb^6tyi3< zK4Z1Y;)*_(vk^63#(!F*)7;8_hOKnr9S)j45mZsB0TOb@Qb1duBi_0bfQ4vwWu@(8 zw*MT&Bk-RY2Z?&?bQ*>SC^hJlAS?J942G}T*+R|J>2oap>O{!-%*t7CT|rxu75okQ zEr+=w(KD_r= zwIEwp)GYl&_eU{^8tTK7eb|FbTU}wGDAYF~(r1+kcD>-0^vehImd>npz>ip9ZO={4vdF7}$xcHd2%gR-p zRFd~C4f~3WPnbGd*7_u+k5dw0AMNcXH47Yp?hkhOBb4r44ZM7~%digm;LyY+l~G1e zpIUrW|5aTC-i76wHJ|zhIyF#%y+&rr|69fp0De5!Wra}kb=(qE3swwdD!5`P>OZ*Z zd}fyfZy-188hTO%O2fRg>x6!QP=dL#y2rH}l9#U%S$+1A zj)d{IO=bnqcgjqKgP+?OU;=M2Ivh44&_{1zfj16!ZN5yVi&=~yeGPB!YZJU2QpD?c zya|Jiw>YA%%JH+FCH)C&qs4oBz2LzKC!n`U3W;fb z{dj4ES{9sAln6=Va5ttNMXl(C@{)RUi!cgZ>~C0%U=yUbN4UT)9`hfvqhi$>o*KP? zb|q3#db=-8a~fevpDnBFaX=XJ2!f#0H!2xJL90X%z3Ht_iA~H z3Fp_ZmxW#e`ql;7ivNVKtfS4!0=g_%I2#la7yBFS=971;fV!?9eh}?F)vcrT=upBh z{G+uf+bK9;+4-W5BCEQ3W4Hpek^jNMlCK+STfb4rVZk2I{})}hNgCR_EQtSn{D>S| z-6FGT3(9{kNS9~&QDdBm&X+36IR!URV||OAz>xOVn0i-b3v9$3^{H_b@9;Tb^;kqLBH$pkNkY#(VNx*4 z@o|hU(8oKLLRQF%U5!FLrdevmx_#Qi`>BLA*f5<55&ADXOI08xXf^dQ=N+bN!Jw(|2-hDqx!j_TJU}*#a>0Ps?Sr5 zcy!D=;_n;ZCQMKsQj>+AsDaup*dSKv3x@FP7@W6++#@oiX;RYba-e2|cT<2hBH06Y ze*wdWR?wHw+Bmn~u$Zv>=_5xhJ?0&=#j~STfruGu5po61iT3o~L;VsBl>S4fFbUMe zWET5cy)>CGW~_bX!sUgcbdF8RPpGH3h=uq>sdf1o6^P)I4{y9odo{laF?L%+AT1vR z7@L(Y9qHhQ@W)xfyz$%A)+^Rm*HNWQeox~npiuKf*AK_d*Fof1y!GwNa_?0edte3L zsXY4gv@rsq^&B{se6$ds{ci3N4T;nDWlc{_7q!8#7ty!&vh6HwFc0aD%33YfZT&V^@q|#RGv{N3_VL1N%%-2UKItk9q2DWc#Qmjfl~IB_kf3MdfO=7kl@;CQz{sAX5gxBBTWR;{pV*_J82JSfr{K`fORf(_l}I! zTu$gzwr{^CoAcgdE&HSPB#Nos^BqA(5m$Sg%vDpzT4;FRF^bv8EVZoFJl)gvc~t1+ zT*M}K6!Ypq?8@ERIV_e2D2nt|Ro%UBdH>sFcD#N=%>9|{)4#>%6#9sYiHQZ-IlCi2 sU*h9;Hs(bJZO!|&(~IR;sxz(pE|Dni?&o>H%S0*zT~owsZPbJR1N}gNkN^Mx literal 0 HcmV?d00001 diff --git a/docs/reference.Doxyfile b/docs/reference.Doxyfile new file mode 100644 index 0000000..2610dc3 --- /dev/null +++ b/docs/reference.Doxyfile @@ -0,0 +1,2385 @@ +# Doxyfile 1.8.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = Eggs.Variant + +# 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 = eggs.variant + +# 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 = "Eggs.Variant is a C++11/14 generic, type-safe, discriminated union." + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = . + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = NO + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = "requires=\par Requires:\n" \ + "postconditions=\par Postconditions:\n" \ + "remarks=\par Remarks:\n" \ + "effects=\par Effects:\n" \ + "throws=\par Throws:\n" \ + "exceptionsafety=\par Exception Safety:\n" + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When 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 by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = 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. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = NO + +# 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 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. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = NO + +# 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 = NO + +# 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 = NO + +# 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= NO + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = D:\eggs\variant\include\eggs + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. 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, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.as \ + *.js + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# 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 will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = 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 +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is 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 therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. 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 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. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (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 + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered 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 +# , /