From 346e30559322cea76597a973adf82a3de0ebc76e Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Thu, 18 Oct 2012 12:11:48 +0200 Subject: [PATCH] Updated doxyfile for version 1.8.0 --- doc/logo.png | Bin 0 -> 8453 bytes doc/man.doxy | 70 ++++++++++++++++++++++++++++++++++++--------------- 2 files changed, 50 insertions(+), 20 deletions(-) create mode 100644 doc/logo.png diff --git a/doc/logo.png b/doc/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..80b5f9d4f9ebbac8ae697a2466cf9dac841deb5e GIT binary patch literal 8453 zcmcI~g;N_$&^HMloM6SB7AaP=I6(p>q_{UgDef-CEx5Emfub!?+?^1tg<_>Zaf%gp zcRrqP=KT-e_hxo?X6N?i_HJ+I?ze}8!&Hbsv>*%&3?is1MC(x=K2kj%&Lc0)&fk0# zJRV909*S;O<{q}rPRu&Cj#d~tHlEB9%$k-S%t8VJ;*U)7g}9`k1T&w&W3z`XeSb8= z^?+(9;ZB2?Fhnrb)h{C-RroHdhVB>`j9vc`pvP86`%#HyEw3Sufl-r4aBGf@fx&DF zg~;pp%D&=%nem>JT^|X}KU-xzHFK@Ivpm9tWdF zxLvQmTysLBAMGz}I7cIID_KE)~?bDsc48vrJX5POjje9wzkF=kfD zCmQ49(+`m~u2~$^*=&ostR3eH-x3E^!7@BvWk@2Afo2e4Vq;{ANGH_zO6vAl~IycDzH@JvY5tGxy(@y zJe?THjeqyrcnk|UYt3w39fD%t>=F(M(Jy)WR4@N)ON#cqZE-n%- z7OA+pKXf3frFzjb!o9Pvjbdkulk%drX#|GR)%GFs!a8ea6prs-I@)=MV9#f|bR>Z3 zJa^v@_J&x2)V%HRlrymhm8w>!L;slTx`hNMpi(^uAF`2Tx!Rj8xTWbG?$ihXLANI> zZvtY<9^GZdsPn<<;M|8y_H-@3+k%lTl8Ebj6pW}y@OwZ|uAi}mfA)Ke2c?BV6* zcf7_<1Y(q&#VB4X0!VzQrKm1wf7;|yp71(XOyHaVbR7p?1z&P|1m|!qZ5NvF`WXIb z+|bFsHc-p}fnxvoLNfSzcc(lE+gU@A-Wg9(FhxHZ5>dOT999HolwM@b)icCF7UP7T zy)~||z<#%rFhT82xZt`n1NB2#OdxfgzEjvfA7YH9;p88lj31$R;~1UeRE!1M(MW=n z(J*?Zc$-F&EA-n1kZs)-E@g5iIwp-h4=3wN`%AFw2ls==5*IJ2Kj$Bop5ct)j1)YR z!CZAZKfe37&$)D6D*!66BnMsi?`}Z41MN|l< zyJ`tzLl0!RAMg1?8WO+BcS+-*Mq!^3NIaQj!<2})3-WbY*BK?NltvVs(YzyJXy?Z~ zjG0mKeGEzIbt7Y1$9wu&Kf~Okuj3n-r-n>>iL=xzjpfRJ#VE(LNwA=TcDTX^Ys0F^n)XSA)$e?+?ZbU*agBmD2HmB=v}9E<=-hFEV&0B(`MmU=4^VC^;VNe5re^>5WY z)I|M_C%In+WD(9$z>;_V0`5sMHlzQwEhNnOmtZ*gZC16^aWK@}BnP3yqX7$Vl zY>4f!@(Y)x{8GlnCyZaRy5^;+ka3CEOC8SB0&~&C+3npDu^oS$n2iX54K5If>-w|InhtYruzf<*(PAg0`d?yT ztBqZgDiq=UJ6a{bkMKCJ;|JzlF;FS}b%tu_FsJ4Yfw-gXtxmE^poPgCkcv|G+y$|? ziY_(|DclJjH{LX2;!LdchW(55Fl=ezzqSNmb=_z9J^>DZ4Q-CIv%TRe5iPn_4}Rp8 zVoa?bkV_Oe8CBu#mCsUH03l$ZCMH>~OWdT;!)5liMIz~emAv@N75*N(fn3a<%?`18 zJ~JjDuBaiL$Wd$@7z@e7sO?V5U<6jS3J?|5UP;ws9^-Z9dOU)ghRLBmpzVyQ&~@JD z5H*>4;LzL9dCJ09HRo&DL@?d^M;52%REDH<)MwdqHe1~0*=)NY`}7sM1REW!{&Yg! zeYSOCOc#)Q;>%rI?1gay?e{msg*iD;x$o>_%+Xyi(sti+_0}sR=U6sY%>c2+iU$GG zah=lOXyV?aft^Nr;tXLt8dnB^bLHduiK4T!Xw=6O=$Bw)){zF%laWr0HnXB?|1!^g zW3ifYHJu-EK}5^jQ2}rre82nWaWAn0{ESJf7SveAxdOkn@6Y51vH$LJ4@Nd&vdI#B z*${X9bi%HV=EINr*3nKiea%~aK$O?GYf|Olzq(>i>w3o|)xXWJy=4c!Xu$VE%}0yv z|AFflLfOoWn>((7mQlr&$sQV_^uiBc;H;&hD0(R+ZL3f&YUHLdVI?LBkph=ta_!Qos0zCCk&98T-( zneP(*z!}<+W%hep8V1uHt$6FtoFE4kH8S2?M;frx$42394#w$;qjml6>BG0dcF>C^ zZ^uMqah!~64McZ(uw3N09yAyerSQU0&C*z*Bue(tu@;R5d|Yx-6q^Cx)g zLfyA)z!$L7g=f~m5$9M{)FSh?aSnb(4H&|gLc)H};kSl% zOb^KLThfMPZytj)Ra%9Hvy6u?H0pcpmOIQNPiSr9mip*CcFm|<8hrM~v{tDw-2-3k zEyQLwMnkcPM=6K8Jyr%FH@ghX1%Z*o;2@r9%n&vc`2hKD_1{eu~kwX%m6Uh zpv@Cbv`uK+*o?PHY1jelQRrzUblYFO>hrBvKDTEX7bP}yEhvrM@L-~LS8u$zzb?+x z4x{EBr)B5{68GkLFlp1>z6q%OhVpRH`}fkpWVD2==ldUer9D{S16k7EBH8At6Hryw z7>U6tt;<~@?_y3kyyw(Eq)m)_`X+~oNqTm(9?Bpn;pyOCNmj;quIO%C!6{jaGg?H@ zOq}5oHvUHdCWv5lnZo5(OT2{F3T@U)>?KPAau>;ajUU$H?~CTv?3=v#Z)jb9w8`C* z7V}wTE6-2mUbvI!Zi8q`yJ1=2*opd(o-?xBE8;v9%-s~X zAg;89$9t6l7D_jvniYR@`nh!!jK|dwf-1S{#O37onx*|-;qzi@QA-UKO!Az>qNnPv z^0b|mZuN{G?tkG|Tw$Kktm-sOZX3O{a07v1c{lhMUL}50Zn>AB;%5^XIE&qRco_rjA=(9!Fw=S5sr`Lk>I&DRDrJAwHvPEfGm3%B(! z^oO?WM)n50v3=u^P1=4gS)iR}bUByK7jot$RZ^OE(&in{;>45$N3QBs-KE1D^e0Tc zV_)HkK%f-Mk{of;OCXIOpTIq5-bJ;$EZ6VL-JrztJCI9&v@WsAH(+_kFF#6lgly8{ z9Ax=YK>7I#!EHZHR(E#}O*GTJmde=^Z{Ihr!ib@Gw1}+7Y|2EfzrLkEiIClDt9L@NFGkU@wI-{0erQn9e`)BFy(tE$v ziXCKl?}F&Ee9lClj!4t8YS_<)nrKpOM_pQ%3OjzhgQ69$GxK#T%RkF@mbv)>cx+kquW(ejY?- zO?Z7~_4fM@K*NsDjhvqCzPTc%BQUOUh8cD9z1;OwfdqqY4ag_(4QVQ9&>N5y=*Wkg z`qY~JXMVN&)JuSr*i;^=?C;41jx=~hLPgMNb16Dn`^CKz;&kJ26Ftj0NNVqc$n{GW zRG&4tJ_N)*bszYa7cQC75FFh6oP+Mp=MMH-a&whdaf29u$YsJI=;V=KI#-5$dx! zjyIUcIFgRgZPJ{ke96WQfy|Lu+qMj1hoV8duoO=;YRW=i>-_S(#JO(Ic_*WuYNIf$ z^ZohB&z76lx|pSI`$gksXI|$VZaGzVB$R%t2fv(~SZnmZq9)M!x{Uh1Z<0COex`qZ zbZz2ue(0T_Llwo|5D!k#dxA}W!2+ix1te4n_ap3$i5nffW}KmgTgG>h{I#*E+?WiB ztjmnF+>yfdE7-0j#Sf}dX3b0T>b-9^fqh;JiQ+*mtX#9+!GY<&t+Phn)Gs*1d?Oi_ zeXB)eXlP-vT1fFJaLM^3GkOYkFyZ3ih^1J$@4=gF0AMn$Dl8h>$xKot&JsXiUjTloH-OB<7TwtI`Z+e%@fb}waA zOo#|GK<$$wm%*E?4uzYye8tgDa#_}!?fTamILiFLk2dDQrf(hQ6l40hvp5d2*q30r zF};7jM)l+Ma4gp~Cs{OH;WvppLhZ;1Y=3~h_ezk38LW_1Ihjmr7lUe66w1}q=x+{p zB)QD82KTWdN9wrm8%cpVM{>MJjZwH$w>nDi8W-PTKc&!aRj1b|)^uUTc37Imxmfc^ z;55lqZPB*coPcryhs)Y(2+IG%h@SxduBZ;Qe=mD zs42MBu@iGt=6@w*qeOzM#TK?KZI#1EmT8MC5E)-m#R0g-^OGy({0+x)g0I9lU4bKR zuay;Cbq^-XC2r^3-|UeO8Qk+?`p_}1v ztKaJzLR`*yD?TA=f{Fo@dtf?^#MD;Zwi-GAQs`^iNK?9ytab9}LJA(ri4QLySANr& za46uZmzNUPr#nURp?v@6fCQUtN#T_5~=a~4*@DhkWRRUOL@9<8=B zT$u#^*-tn{v`HQborEY+5Lun?Wkg4?ZOZcH=u}FFt_>|Sh)%_J=|fEZ0U)V%gWBlz zjsNl^?=2<%)f-+w+cQ>L0sLmGZ=0v>F4$~~bb^0vV@=g-IhV^a0z08W3qs{R3LYQY z)yKMO`2O>CU4}5=$PrY=Un7-cqZLzT@x6v41pp3i)5lB?O68v79enQ3$98kk>mC$L z-!0;}i&jmjDERSmJ+RFv8{B!Y#(~e+BG+?h-#y*deUPbp4Dp;az;AD*X+F8jsauON z(DS^c-|?EQoC;250(f#kU#v93xj+dyOFmL;)EN(W0w1|2_o^^B2ETo)qsGh0&&4H2Q~blM6&c)&?iS)fu?ek=@977CpJXGYEYu!T@$Tl@a({ zpYDwF(<_^)33(WBXmVVFPjjaC#@11pt-wrgO?1#scTBneUYNtCPKZola93qYL~P`5 z6^5PW=Qn}|T%ofoik4h9ous-^8arlwJc4-m*Fvw}l5BfGvP}R4Y43{xL3dV0S!Mka zNW7U|bf~e}zuk`v|B!=_uL1Yc_YhFV7R7)jL~KW%|2iJjQVLcgHD!7K?C_Sg)U)h! z!6si($n7tBIi9EE-PAbPHpxcbW43K(CcP z=(~<76K6b)CzbMKL%=fEAsuIkgpMeEKYCY1sc;wiEG6)8od@jqAOWM{_(yPhWMQJn?fhd^qgv9sxx1PT|tzr{s?KZ@E8+Me;yuaVUm>j1{@>Ku*dl|Ap z4ev8$=w{&2c+$(`@*Q(-_e!15>^hVwxq7N0$AG!L<`A8VA{@GvnH+k&@q3s+hB=ik4k^IB>(94wpS>#i}hJ2lK#Wm|%1*4@RT)r5}N7W?w(Nm@2L{b`#|MT-+_ zPiQ;@Wqq*??y5hoX`0O47LZbP+U6aw+dj_K3?152MtiivN@Dl3qw>=wDZ#QY1Teyc zV{*^8v@!<>DjL^o7*-~qrh5nuC$gN(O6a_>K`a)c@dh|&VpC8ze2C%E5Vo?4eh9th z-(-1SGX+MUFCO;4TNTlvnzH!IeWRGg7dIwiPOW@#MHL8kfvYn1x5toAzA$6Y=T;nO zOZG-Y^^SSH^2>fE%dfqkjuYiF2MZI^qO*u*ufuumUsn4mzKS38mXa6OHvYQF+UmLd5{)3<>o%r(%W@&&z@~C&c*gZ z;ps5e?Ke!5Q%5Cq^ygm2}uzsSUtU8OU1u6>KHDx_vp zk)R22&}!@7o#stpEl<6^?h0Vz z(*?5LowWgC$5VB%R#Wf(DgGDjOJ5HBD`g&8&&9_F@DAg|BM>!Fv~UIbnEdaLmgG4) zHO;DTyGlUtolL|~Xa2cUrxTc}#TX5g{$lwrjHUdpg@mk!fk(!JYK})m`^!1-T7!*6 zJ44!mxFJ0@i@aQzVTCZFH%brFKMg}=U|dg31JjYuh|YC~Uz#mcLYBz#XUFfTp$gZ| zV8?`V+upg0r{awoFlUExt)W0}P3+Z>uDX&ADY~bbgs0pdvkKm0aLnvkSOG^3qhDf< zbFJ1so=$IC;hv|;5WdA?6(vPnO36jVYCjtygmI!~eZ#!`?ny&D-HT^VVhvHBeP25i zFc)2LCQ5Z>stT&IyVK#mr5^LI{iEj!*T(sTZd0R;dEN1NNE~j z0=+#=c6L*;?-h*c_4}w2tm&Ns7fbd2S`i=y_x>59MNxlXWy}`7qwDeN`bMDgz6RHD zp}2yMKmyyr9C45$uo#3Pjv7{>Hr(<$b5NHjfGAP+7Yg_@C#iRj6ra1_t1=(3K7y_I zZA~BZG(889q~}qzy!n5!*=tg`_~z7E7c4p8B}ETAnyH7GZc=j=dk*M)vAfx7Lzbby z4Au;u0M}h5wYOB&5zWr+SGHt&WlyDd6}hPAQ;CfyycAsK)USk~?JevpC^;&mL|ss7 z$&F!bVDXqg;CS<%*Zv#K8BIINi{s;ysYh}0bhy);%`65Keotc&Yj6^;WT&63FR4TD zLeKE3apz~nhw=t4)oQNtAG4`?+&KtOZ40Rvn%eb_iPUBMU68SGfy(QUkg?bR)A>S= zettw2+!HG+htT})!3XX-|93B9K9isV#yk>5TCQeg!UnJh?7aTUS)l*Hzrywx(k>oN zz8%8}o2o$G*^pO|)gD`J#h=Pb)5@#=YV}1O8apGqshm2;%uS9=F~Lqp3TIyFkvhej zGQdXLa>C`+VxoZ465OvGiv%#$184?=&myB5ZVnf?jBOC|fHZ&AHj2LF_gy}^*esj7 z!*T$Zj@PVenmgQnj9E4AuzuO*2N^7(Gr!=rpKzgZ)5X&6bSm)4$I;yx>u%UW0UHH9 z7;w|JrcX1ViL|teIgHe1gVEA4e8N1TD?1)0*Ob_pRn_Sa?=m;lhJqjD${;t|~y6rB9$%>GG3iry(|n&d9R=AbGP-bBP)9lDG1zak0) zEjyY$XMOH1XYCC{z#=CEzX=d#Z6n=aSt@+`3Ls`#aGjBGcL4Xl;#iuFqTSw>;$3GS z*Qz)4eFVV2TJ8>WMw+h58==v=KXjVS$6)SUj1ofHmvOG&SXiJbLDJm)bot$@tFRLG z9v}>>$SH6AOGxbkC(K#I<=9dXk=uT1j(uju-Cg7-n*C~>v?rXNV3slESpvH3Q~#!8 zlDEiff$xyc*btf3kWh=7NVxSnksy93b~gQxjavV;8~M2_m=bq*lQ3KOCL{*a;$4DT zw;pM!9w|PLhNVB>v$@cOvuW(u5t+;iv$}I<<(E4za*=Wg$WtKLP^r6)wUv?rQ$kVq z?V0}OUCunhg_3t^!cu|ciH#KIgnmZJOAg7Qq0Mpz!GDz~omZXO1$F+RBJ9Vs;AKB@ zzd|6Jf{=YCCHp&in%2o}2dY#KP2GACO1}vTJMR>M0e3swHTm(18C8_oJCAo-eyAs( zjd>xTW~j&b3gPlbjE*g!Cc_01g6Yo&Q@s-r(^>Cs!Z&??LD+4i#k#rijiPMfF7~3n z&V9iJnPULb(syzvJcpO^bkcqwHyzlIItw^|RtXdT|I+s|Df0ik68^tge!rDHfzlBl URU0!uemuZ{D#0L?3W(7E2QF^jwEzGB literal 0 HcmV?d00001 diff --git a/doc/man.doxy b/doc/man.doxy index 78b2314a..075b58c4 100644 --- a/doc/man.doxy +++ b/doc/man.doxy @@ -1,4 +1,4 @@ -# Doxyfile 1.7.6 +# Doxyfile 1.8.0 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -45,7 +45,7 @@ PROJECT_BRIEF = # exceed 55 pixels and the maximum width should not exceed 200 pixels. # Doxygen will copy the logo to the output directory. -PROJECT_LOGO = ./image/logo-mini.png +PROJECT_LOGO = logo.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. @@ -250,6 +250,15 @@ OPTIMIZE_OUTPUT_VHDL = NO EXTENSION_MAPPING = +# If MARKDOWN_SUPPORT is enabled (the default) 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. + +MARKDOWN_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 @@ -332,10 +341,21 @@ TYPEDEF_HIDES_STRUCT = NO # a logarithmic scale so increasing the size by one will roughly 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 +# corresponding to a cache size of 2^16 = 65536 symbols. SYMBOL_CACHE_SIZE = 0 +# Similar to the SYMBOL_CACHE_SIZE 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 appear 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. + +LOOKUP_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -352,6 +372,11 @@ EXTRACT_ALL = 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. + +EXTRACT_PACKAGE = NO + # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. @@ -581,7 +606,7 @@ LAYOUT_FILE = # .bib extension is automatically appended if omitted. Using this command # 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 +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this # feature you need bibtex and perl available in the search path. CITE_BIB_FILES = @@ -1158,7 +1183,7 @@ FORMULA_TRANSPARENT = YES # (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 also need to install MathJax separately and +# output. When enabled you may also need to install MathJax separately and # configure the path to it using the MATHJAX_RELPATH option. USE_MATHJAX = NO @@ -1167,10 +1192,10 @@ USE_MATHJAX = NO # 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.org site, so you can quickly see the result without installing -# MathJax, but it is strongly recommended to install a local copy of MathJax -# before deployment. +# 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. MATHJAX_RELPATH = http://www.mathjax.org/mathjax @@ -1518,20 +1543,16 @@ SKIP_FUNCTION_MACROS = YES # Configuration::additions related to external references #--------------------------------------------------------------------------- -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. TAGFILES = @@ -1644,6 +1665,15 @@ GROUP_GRAPHS = YES UML_LOOK = NO +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances.