From c18dc6fbe5b68312be52353aa0a493106584ffe7 Mon Sep 17 00:00:00 2001 From: Konstantin Podsvirov Date: Thu, 4 Aug 2016 13:01:42 +0300 Subject: [PATCH] Added CMake_BUILD_DEVELOPER_REFERENCE option By default is OFF and marked as advanced. It's also add custom cmake-developer-reference (ALL) target Generated output will be installed to ${CMAKE_DOC_DIR}/developer-reference. --- CMakeLists.txt | 5 + Source/CMakeLists.txt | 9 + Source/QtDialog/CMakeSetup64.png | Bin 0 -> 7213 bytes Source/dir.dox | 7 + Source/dir.dox.in | 7 + Utilities/Doxygen/CMakeLists.txt | 98 +++++-- .../Doxygen/DeveloperReference/mainpage.dox | 8 + Utilities/Doxygen/authors.txt | 17 -- Utilities/Doxygen/doc_makeall.sh.in | 248 ------------------ Utilities/Doxygen/doxyfile.in | 35 ++- 10 files changed, 139 insertions(+), 295 deletions(-) create mode 100644 Source/QtDialog/CMakeSetup64.png create mode 100644 Source/dir.dox create mode 100644 Source/dir.dox.in create mode 100644 Utilities/Doxygen/DeveloperReference/mainpage.dox delete mode 100644 Utilities/Doxygen/authors.txt delete mode 100755 Utilities/Doxygen/doc_makeall.sh.in diff --git a/CMakeLists.txt b/CMakeLists.txt index ae5990ebe..3aef61973 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -93,6 +93,11 @@ option(CMake_INSTALL_DEPENDENCIES "Whether to install 3rd-party runtime dependencies" OFF) mark_as_advanced(CMake_INSTALL_DEPENDENCIES) +# option to build reference for CMake developers +option(CMake_BUILD_DEVELOPER_REFERENCE + "Build CMake Developer Reference" OFF) +mark_as_advanced(CMake_BUILD_DEVELOPER_REFERENCE) + #----------------------------------------------------------------------- # a macro to deal with system libraries, implemented as a macro # simply to improve readability of the main script diff --git a/Source/CMakeLists.txt b/Source/CMakeLists.txt index cdc8fb132..b68675daa 100644 --- a/Source/CMakeLists.txt +++ b/Source/CMakeLists.txt @@ -50,6 +50,15 @@ if(WIN32) add_definitions(-DUNICODE -D_UNICODE) endif() +# configure the .dox.in file +if(CMake_BUILD_DEVELOPER_REFERENCE) + configure_file( + "${CMake_SOURCE_DIR}/Source/dir.dox.in" + "${CMake_BINARY_DIR}/Source/dir.dox" + @ONLY + ) +endif() + # configure the .h file configure_file( "${CMake_SOURCE_DIR}/Source/cmConfigure.cmake.h.in" diff --git a/Source/QtDialog/CMakeSetup64.png b/Source/QtDialog/CMakeSetup64.png new file mode 100644 index 0000000000000000000000000000000000000000..43a8cc6afa289368e844159861ddf887523c2cba GIT binary patch literal 7213 zcmV+|9Ma>7P)KLZ*U+IBfRsybQWXdwQbLP>6pAqfylh#{fb6;Z(vMMVS~$e@S=j*ftg6;Uhf59&ghTmgWD0l;*T zI709Y^p6lP1rIRMx#05C~cW=H_Aw*bJ-5DT&Z2n+x)QHX^p z00esgV8|mQcmRZ%02D^@S3L16t`O%c004NIvOKvYIYoh62rY33S640`D9%Y2D-rV&neh&#Q1i z007~1e$oCcFS8neI|hJl{-P!B1ZZ9hpmq0)X0i`JwE&>$+E?>%_LC6RbVIkUx0b+_+BaR3cnT7Zv!AJxW zizFb)h!jyGOOZ85F;a?DAXP{m@;!0_IfqH8(HlgRxt7s3}k3K`kFu>>-2Q$QMFfPW!La{h336o>X zu_CMttHv6zR;&ZNiS=X8v3CR#fknUxHUxJ0uoBa_M6WNWeqIg~6QE69c9o#eyhGvpiOA@W-aonk<7r1(?fC{oI5N*U!4 zfg=2N-7=cNnjjOr{yriy6mMFgG#l znCF=fnQv8CDz++o6_Lscl}eQ+l^ZHARH>?_s@|##Rr6KLRFA1%Q+=*RRWnoLsR`7U zt5vFIcfW3@?wFpwUVxrVZ>QdQz32KIeJ}k~{cZZE^+ya? z2D1z#2HOnI7(B%_ac?{wFUQ;QQA1tBKtrWrm0_3Rgps+?Jfqb{jYbcQX~taRB;#$y zZN{S}1|}gUOHJxc?wV3fxuz+mJ4`!F$IZ;mqRrNsHJd##*D~ju=bP7?-?v~|cv>vB zsJ6IeNwVZxrdjT`yl#bBIa#GxRa#xMMy;K#CDyyGyQdMSxlWT#tDe?p!?5wT$+oGt z8L;Kp2HUQ-ZMJ=3XJQv;x5ci*?vuTfeY$;({XGW_huIFR9a(?@3)XSs8O^N5RyOM=TTmp(3=8^+zpz2r)C z^>JO{deZfso3oq3?Wo(Y?l$ge?uXo;%ru`Vo>?<<(8I_>;8Eq#KMS9gFl*neeosSB zfoHYnBQIkwkyowPu(zdms`p{<7e4kra-ZWq<2*OsGTvEV%s0Td$hXT+!*8Bnh2KMe zBmZRodjHV?r+_5^X9J0WL4jKW`}lf%A-|44I@@LTvf1rHjG(ze6+w@Jt%Bvjts!X0 z?2xS?_ve_-kiKB_KiJlZ$9G`c^=E@oNG)mWWaNo-3TIW8)$Hg0Ub-~8?KhvJ>$ z3*&nim@mj(aCxE5!t{lw7O5^0EIO7zOo&c6l<+|iDySBWCGrz@C5{St!X3hAA}`T4 z(TLbXTq+(;@<=L8dXnssyft|w#WSTW<++3>sgS%(4NTpeI-VAqb|7ssJvzNHgOZVu zaYCvgO_R1~>SyL=cFU|~g|hy|Zi}}s9+d~lYqOB71z9Z$wnC=pR9Yz4DhIM>Wmjgu z&56o6maCpC&F##y%G;1PobR9i?GnNg;gYtchD%p19a!eQtZF&3JaKv33gZ<8D~47E ztUS1iwkmDaPpj=$m#%)jCVEY4fnLGNg2A-`YwHVD3gv};>)hAvT~AmqS>Lr``i7kw zJ{5_It`yrBmlc25DBO7E8;5VoznR>Ww5hAaxn$2~(q`%A-YuS64wkBy=9dm`4cXeX z4c}I@?e+FW+b@^RDBHV(wnMq2zdX3SWv9u`%{xC-q*U}&`cyXV(%rRT*Z6MH?i+i& z_B8C(+grT%{XWUQ+f@NoP1R=AW&26{v-dx)iK^-Nmiuj8txj!m?Z*Ss1N{dh4z}01 z)YTo*JycSU)+_5r4#yw9{+;i4Ee$peRgIj+;v;ZGdF1K$3E%e~4LaI(jC-u%2h$&R z9cLXcYC@Xwnns&bn)_Q~Te?roKGD|d-g^8;+aC{{G(1^(O7m37Y1-+6)01cN&y1aw zoqc{T`P^XJqPBbIW6s}d4{z_f5Om?vMgNQEJG?v2T=KYd^0M3I6IZxbny)%vZR&LD zJpPl@Psh8QyPB@KTx+@RdcC!KX7}kEo;S|j^u2lU7XQ}Oo;f|;z4Ll+_r>@1-xl3| zawq-H%e&ckC+@AhPrP6BKT#_XdT7&;F71j}Joy zkC~6lh7E@6o;W@^IpRNZ{ptLtL(gQ-CY~4mqW;US7Zxvm_|@yz&e53Bp_lTPlfP|z zrTyx_>lv@x#=^!PzR7qqF<$gm`|ZJZ+;<)Cqu&ot2z=0000WV@Og>004R=004l4008;_004mL004C`008P>0026e000+nl3&F} z000qKNklVF1V;Yg2fwZR?#x?^4GTXG1{h;Hr@&oz-F4-2&bE2=)va7}%?*|PhD;m~ zEGlF|P%8H)%~qi8W7U8so_ONQDy~v!ty!?3eB|QA_uqT;Bup$E$o&41iv2aQxxl86 z6@Yc?)?Lwyi3q`<&7?`6tsF4ura=t{j}o(^%o@}`@avk`%D=+@_B9JS0r2FLPhQcS zvu&G#g1nL6`~K7S9zO{IJ4mx}7}_sNMUaXON#+5+|JVRXr_)#TVy^2lWy*re0RwLy z^ueAM?0`dz5GEXEdWgU)X;!?i+0vIR=u;zP+cIj=;;-F%^!*fw#uA%^aYzS(46&gi z%zR+p->ef{Fn>{He!-1{&egU8220tr8wVW-Vt^SD>`{u9K=^MCfIvWvx_!~wv#uV3HGvmW5&$&+l_^unlxx2?JN-J?lF zfiYfHuoR?Bh?En>wiViFii5&}sHu3Og)&4oN?!ud`?L?Refyudaq6tfX#R}@YY#UP z2;$AYfYAmmArf|okZqAnYYf7isMwohdc`r+mi%ZWj!54C5Q#*3_2jWwjAx#CdURRE z{rA3mBne8RwIJe|BBcz55N*m~K)^=QX*7!BpyHNjx?+8cJ1^zB8&zKc@aUtD_R2}M z)(jpzm`Ef9gjV${oH6j=(R!S0?h9g!zwZzyh#ia|ZS8pIDCXt|?U&+-6-VRoEkL|a z0C?!3hkEVAd3jMLj2}Dtp5;GWe)vcdCHTtkFMP$IwFU{&VjQe+6q@Q0v2aCE>?juI z>xzGCOwI!~_DLD+%`(&48l!mV$W`I!w4!r0%^=`vul%{%;QFs34z0$)jzka?N?C|l zpls&$bL=s;tNl%#q1kh-I-_=+uK&y7J!eNvs zL_7dAieVv#+X_MzSJEAJN`c9fC-+M2-@A7&WfgZ+D*J|_nwmNsN6;FK7?cvkYefMD zkpM9rgm45wP)Z@9Kols8vi^DYrsl-T_fmR`h{Ufb0FOWZ_+_2UaU9-!^G(*R`+Dj8 z`Ky=zvU^2(q{fHpUX2}M!L0%aj6L@8WR3=IXiy??a)v2!i+3~Z#A z+xVRTm_B{_WuNf9_YN^<&caHp8;YuH>IgZ4s|`wl7y)BYA}BzML5ZR*9YhDCC}sO8 zASh8F7AQq|Q9pZQQ+(xnNxfyjfB|vo#j@B5fVFGaUe?Ki!5}A2yk9zJ-iqaaIna)h zj@dUx5b^qsh`|_8%9EisH$XZZ!Ln?O_(G@z5rr1TuyBAy1NxQ!YgNNM1HI}Fdo=|B zZnyZZl)p_LsC1m+ac^g&`mJI4&-rE(SR{^M~SiCCfURP9A)8acq{9p~*^^8yUy*9Wm7#CdQ5LZELC*)gX z%L`svSjs{vuOiGJTx5?A2Uqr{FX%M@oS;=Yw`}#7-`*EP{M^^Z3sSq_8ay_*WM^M% zgEj_(LyNWvgu-6%%0h`3xW@(ySA-FfFiQs)Wm(W0{ea5`z_vXZDX&<(I-a<;sH&y~ z5pZ4Y&$>TcAB@bt&H!RC#-YUxV28rq56q-M4iiKvj8fcEJkXvHcCsw^s79?@5q$8$ z2QMl3P$55qs@jzY z<87B+5iTnQj4>QK_|Dj}^81&+wWk$J`Qm0gzwc^8I->!8HPEj1s)DOA8q%(!uJ&ER zg$fBr5#I+WrBId+fMxltP-uY>c@gd^DJ}=*^=b-SECY-&>aFZ`O7dtvhGm)UIEJD z*5O0#U!AUAd7$<3`URbCk6%hY1p+q1h7K9GdhLJh*tTgm&g?4z z%L>reo}jhyHP(D}Ft^+~jbr-{Gw9i0p!dFo1VdRTsInk*Xn|4+$F}+L(GSw!Ie26# z@WMx7?`5SxDwXD%Yd^QDrG0W?RZTM@2G_6inPCi__Kh|m0qPqXNXB30!EcRZ-n{E+ zY>1(i!i1w8^jDUj0vTUmcS;LHxUFQEJt;qWS^a{K)DZDje%81dGgmCz`F1mw?bUqa z*L7`7C&Ocm&IVsobBcc9ZT#@z&ob%LqiASoA)QX6EejKgVA(ce<&;6c1gZ=W;=Okf zO7il!`|6SkpsddtBAKncZ1Jjw)`^AHHO(mTzUzUY(b^L_qqPqP7y_I*bC~fXckzRV zZ({JEfiyP7a9x*lI)z3^hr(EaKo0diJ;;ioQeJ6P3VdI1$EQlH$^G&^vODY~g0pAO zzF?dC$dMzQIR3%7n`i#RvX@?K!cyMsi}6aDLNEqIG}>F);~I;zXWpW0RxK; zC&3jFT&+n5gIGZalT3E5|2YCEN>F|^5G80)-0`WatY5r;V&%T3=2w9Dr9As+cWq~X z*p{E4hlm+BbN1?GTedf1StfgvBNLDIpEa^9n^-(Ss_oBw?W_Hne)B{c8r$gZ$B78q z)g*&KEXTo3r#jrAQm70QM6w`cK68PRe)%jb9a;X*Z|^IM=H@05IuXA>vz6J zqUtOv80^ph$Oxg^+FY`2K_LKfSqoDe(Li@d4!(i&s}Sjw`IHZbB5<^}R8k z+8Yz3{>)K|uYHA*2M$vs)x@h4sDvVwNRdb+&Kt>O(tAxLX$K?}?ofP{SrT`60zC|A4vmxnk8clp^!cP#%W(!_S={1vFx1O#~>)sHqAAAnX&i; z_5;=Y#C@8lYJScQr>|$`xtUB#Od{XTBWWi|nbdjLbG^Hz5DH`E=DBnPEOacCyoHsY zCL*MPs|xyY@A%TPJv(-lT?`A(1E42?0w^n6y!uRCY5%h|CkThEtS?ZOO)4q0*Y04! z*XpTTwU6goo`)2q`zP61xPzVX9Sp4+!SvJ9n9?|fVGKh8LQ*Bs#uFIgqphF5du-*N`i574*d=Mem@#9{Yj)Ju*3#TuH{qd2 zUfl7k7mEs-np&|e@8Ze|kccNysW-Uo!8p5?Y-2~mA3Gj;HFWG-fD3`T5T7|UnQ7J2 zn2;Dx)QXU_Q=~=X#^WrhuOYC1FJv?zcc_kLX$M36lIRO&z_xjO?_b=tf7TF~vY z!Y{t~;(50CTi;qoaq+12rPn-m|8F)OClas z0AO-}$d(IlZi>$i=X0m0@Y$y8DVCumQ|&BHHxb?a2Cijw61~hUD}S|>O^+Nf5FudM zRK;Q}-1ySw-F5X#dtyPi0Ce4w$pjVUb0^$9>l-_M_eya=V{;7KQYaOqx%Mn$O80To z`Xs-;>S<0ko%8}TJq(@ms&kBZ8Upnpu01`O&z!uLZ=TL)uQ&!Rrs%*Ewv#o2v;&BHX&Cge9l0VzMqG6b_II8V@tcxJ~gE zMUpwz!2s`8g3Y;Dj0Mkc+WdBH_bliZfKJ^~r5HSDz=X;*KiToi7mErSn_?&l&|ZIl z1z)Nn^uTd`k@^*>MDpThzAFoIL2&(He62`Bl z^i!2w0Q`O1=105tx~sPRsaqCY&7SW3V>1s7*u}nh9jZ+cB#5mn|8}}>ijOhnW1xDGk@o6MShLNyko<;`%EdblOrf}qTm3MbNks(6?_(K*tOfOeD(Fu1J7L& z1Ip$tT7CT7n1W+RPEt~|le>SGVCx;f{gCS+U##S6>Ye4>=^6%K}9{f!)_T6i3BEo`#b-$ z{ontywV-79o6O$e^6XX5aH`Q)dU_~xxuT}K0ARYw`wM}fy8$l42;W!quM1Fqd<1t_ zk7JHoLNpWw$G?yPEQ<|qz3o&${~8F0@%cLOkY&eGMp_vnHN*Y0HMGcEjR=#M$o zaPr~;r<>zlM|VN@6nuBg(*Ej6L*u{{&;H#9+&*VBH%>nnJ-V5-EbLtdJ?u-)^)BiGMejQeLlQh)e3WNm zN4f575nrqt%be2T*7O5I*1ld{vvuOciA~)uhED#qswg(%_?V4HzIWo}{ik%NVCW)z zrW@LKXMyQ~B^N52UB55g2yZT+-MKx1-GMrG%MOO6!d6i@Fx;^NV?I4;(ynd+XlQM0 zsQKf;TVtEzg$_Uf+1{tL!vY vR$50wPF -# ------------------------------------------------------------------------- - -# Path to several tools (_PROG to avoid the typical GZIP env var pb) -# Example: -# DOXYGEN_PROG=@DOXYGEN@ (INCLUDE(${CMAKE_ROOT}/Modules/FindDoxygen.cmake)) -# GZIP_PROG=@GZIP@ (INCLUDE(${CMAKE_ROOT}/Modules/FindCygwin.cmake)) -# HHC_PROG=@HHC@ (INCLUDE(${CMAKE_ROOT}/Modules/FindHhc.cmake)) -# MV_PROG=@MV@ (INCLUDE(${CMAKE_ROOT}/Modules/FindCygwin.cmake)) -# PERL_PROG=@PERL@ (INCLUDE(${CMAKE_ROOT}/Modules/FindPerl.cmake)) -# RM_PROG=@RM@ (INCLUDE(${CMAKE_ROOT}/Modules/FindCygwin.cmake)) -# TAR_PROG=@TAR@ (INCLUDE(${CMAKE_ROOT}/Modules/FindCygwin.cmake)) -# WGET_PROG=@WGET@ (INCLUDE(${CMAKE_ROOT}/Modules/FindWget.cmake)) -# -export DOXYGEN_PROG="@DOXYGEN@" # Doxygen -export GZIP_PROG="@GZIP@" # gzip (Unix-like 'gzip compressor') -export GNUPLOT_PROG="@GNUPLOT@" # gnuplot (data plotting program) -export HHC_PROG="@HTML_HELP_COMPILER@" # HTML Help Compiler -export MV_PROG="@MV@" # mv (Unix-like 'move/rename files') -export PERL_PROG="@PERL@" # Perl -export RM_PROG="@RM@" # rm (Unix-like 'remove files') -export TAR_PROG="@TAR@" # tar (Unix-like 'archiver') -export WGET_PROG="@WGET@" # wget (remote file retrieval) - -# PROJECT_NAME: -# Documentation/project name. Used in some of the resulting file names and -# xrefs to uniquify two or more projects linked together through their -# Doxygen's tag files. Mandatory for each documentation set. -# Note: might be the same as the doxyfile's PROJECT_NAME -# Example: -# PROJECT_NAME=VTK -# -export PROJECT_NAME=CMake - -# PATH_TO_VTK_DOX_SCRIPTS: -# Path to the directory holding the Perl scripts used to produce the VTK doc -# in Doxygen format. You need the VTK source files or a local copy of -# these scripts. -# Example: -# PATH_TO_VTK_DOX_SCRIPTS=@VTK_SOURCE_DIR@/Utilities/Doxygen -# -export PATH_TO_VTK_DOX_SCRIPTS="@VTK_SOURCE_DIR@/Utilities/Doxygen" - -# SOURCE_DIR: -# Source directory. The top directory of the source files. -# Example: -# SOURCE_DIR=@VTK_SOURCE_DIR@ -# -export SOURCE_DIR="@CMake_SOURCE_DIR@" - -# REL_PATH_TO_TOP: -# Relative path from the top directory of the source files to the directory -# (or top directory) holding the files to document. Useful if several parts -# of the same source directory should be documented separately. -# Example: -# REL_PATH_TO_TOP=. -# REL_PATH_TO_TOP=framework/src -# -# export REL_PATH_TO_TOP=Source -export REL_PATH_TO_TOP=. - -# INTERMEDIATE_DOX_DIR: -# Directory where the intermediate Doxygen files should be stored (mainly -# these headers files converted from the VTK format to the Doxygen format). -# This directory is erased at the end of this script, unless you comment -# the corresponding line. -# DOXTEMP might be used to simplify the syntax. -# Example: -# DOXTEMP=DOXTEMP=@VTK_BINARY_DIR@/Utilities/Doxygen -# INTERMEDIATE_DOX_DIR=$DOXTEMP/dox -# -export DOXTEMP="@CMake_BINARY_DIR@/Utilities/Doxygen" -export INTERMEDIATE_DOX_DIR="$DOXTEMP/dox" - -# DOXYFILE: -# Path to the Doxygen configuration file (i.e. doxyfile). -# Example: -# DOXYFILE=$DOXTEMP/doxyfile -# -export DOXYFILE="$DOXTEMP/doxyfile" - -# OUTPUT_DIRECTORY ALLOW_ERASE_OUTPUT_DIRECTORY: -# Path to the Doxygen output directory (where the resulting doc is stored). -# Note: should be the same as your doxyfile's OUTPUT_DIRECTORY -# If ON, allows the output directory to be erased when some advanced output -# file have been produced (HTML Help, or TAR archive for example). -# Example: -# OUTPUT_DIRECTORY=$DOXTEMP/doc -# ALLOW_ERASE_OUTPUT_DIRECTORY=ON -# -export OUTPUT_DIRECTORY="$DOXTEMP/doc" -export ALLOW_ERASE_OUTPUT_DIRECTORY=ON - -# COMPILE_HTML_HELP RESULTING_HTML_HELP_FILE: -# Compile the CHM (Compressed HTML) HTML Help file, name of the resulting -# file. If set to ON and name is non-empty these options will actually -# trigger the HTML-Help compiler to create the CHM. The resulting -# file (usually index.chm) will be renamed to this name. -# Note: if ON, the whole $OUTPUT_DIRECTORY will be erased at the end of -# this script, since this file is considered to be one of the -# advanced final output, unless ALLOW_ERASE_OUTPUT_DIRECTORY is OFF -# Note: your doxyfile should be configured to enable HTML Help creation -# (using GENERATE_HTML = YES, GENERATE_HTMLHELP = YES) -# Example: -# COMPILE_HTML_HELP=ON -# COMPILE_HTML_HELP=@DOCUMENTATION_HTML_HELP@ -# RESULTING_HTML_HELP_FILE=$DOXTEMP/vtk4.chm -# -export COMPILE_HTML_HELP=@DOCUMENTATION_HTML_HELP@ -export RESULTING_HTML_HELP_FILE="$DOXTEMP/$PROJECT_NAME.chm" - -# CREATE_HTML_TARZ_ARCHIVE RESULTING_HTML_TARZ_ARCHIVE_FILE: -# Create a compressed (gzip) tar archive of the html directory (located -# under the OUTPUT_DIRECTORY), and name of the resulting archive file. -# Note: your doxyfile should be configured to enable HTML creation -# (using GENERATE_HTML = YES) -# Example: -# CREATE_HTML_TARZ_ARCHIVE=ON -# CREATE_HTML_TARZ_ARCHIVE=@DOCUMENTATION_HTML_TARZ@ -# RESULTING_HTML_TARZ_ARCHIVE_FILE=$DOXTEMP/vtk4-html.tar.gz -# RESULTING_HTML_TARZ_ARCHIVE_FILE=$DOXTEMP/$PROJECT_NAME-html.tar.gz -# -export CREATE_HTML_TARZ_ARCHIVE=@DOCUMENTATION_HTML_TARZ@ -export RESULTING_HTML_TARZ_ARCHIVE_FILE="$DOXTEMP/$PROJECT_NAME-html.tar.gz" - -# ---------------------------------------------------------------------------- -# Build the contributors list. - -if test "x@VTK_SOURCE_DIR@" != "x" ; then - if test "x$PERL_PROG" != "xNOTFOUND" ; then - "$PERL_PROG" "$PATH_TO_VTK_DOX_SCRIPTS/doc_contributors.pl" \ - --authors "$SOURCE_DIR/Utilities/Doxygen/authors.txt" \ - --cachedir "$DOXTEMP/cache" \ - --class_group '^(cm[A-Z0-9][A-Za-z0-9]+)\.(?:c|cpp|cxx|h|fl)$' \ - --files_in '(?:^hints|dummy|README|^Makefile\.borland|\.(?:c|cmake|cpp|cxx|h|html|in|java|fl|pl|py|tcl|txt))$' \ - --files_out '(?:^ChangeLog\.txt)$' \ - --gnuplot_file "$DOXTEMP/contrib/history.plt" \ - --history_img "|lines|$DOXTEMP/contrib/history.png" \ - --history_img "365|lines|$DOXTEMP/contrib/history2y.png" \ - --history_img "180|linespoints|$DOXTEMP/contrib/history6m.png" \ - --history_dir "$DOXTEMP/contrib" \ - --history_max_nb 10 \ - --lines_add 1.0 \ - --lines_rem 0.5 \ - --massive 50 \ - --max_class_nb 10 \ - --max_file_nb 5 \ - --min_class 0.02 \ - --min_file 0.01 \ - --min_contrib 0.05 \ - --min_gcontrib 0.0001 \ - --store "doc_""$PROJECT_NAME""_contributors.dox" \ - --relativeto "$SOURCE_DIR/$REL_PATH_TO_TOP" \ - --to "$INTERMEDIATE_DOX_DIR" \ - "$SOURCE_DIR/$REL_PATH_TO_TOP" - fi - - if test "x$GNUPLOT_PROG" != "xNOTFOUND" ; then - "$GNUPLOT_PROG" "$DOXTEMP/contrib/history.plt" - fi -fi - -# ---------------------------------------------------------------------------- -# Create the Doxygen doc. - -if test "x$DOXYGEN_PROG" != "xNOTFOUND" ; then - - if test "x$RM_PROG" != "xNOTFOUND" ; then - "$RM_PROG" -fr "$OUTPUT_DIRECTORY" - fi - - "$DOXYGEN_PROG" "$DOXYFILE" - - # yes, a second time, to get the contrib, I don't know why - "$DOXYGEN_PROG" "$DOXYFILE" -fi - -# ---------------------------------------------------------------------------- -# Clean the HTML pages to remove the path to the intermediate Doxygen dir. - -if test "x@VTK_SOURCE_DIR@" != "x" ; then - if test "x$PERL_PROG" != "xNOTFOUND" ; then - "$PERL_PROG" "$PATH_TO_VTK_DOX_SCRIPTS/doc_rmpath.pl" \ - --verbose \ - --to "$INTERMEDIATE_DOX_DIR" \ - --html "$OUTPUT_DIRECTORY/html" - fi -fi - -# ---------------------------------------------------------------------------- -# Create the CHM HTML HELP doc. - -if test "x$COMPILE_HTML_HELP" == "xON" ; then - if test "x$RESULTING_HTML_HELP_FILE" != "x" ; then - cd $OUTPUT_DIRECTORY/html - if test "x$HHC_PROG" != "xNOTFOUND" ; then - "$HHC_PROG" index.hhp - if test "x$MV_PROG" != "xNOTFOUND" ; then - "$MV_PROG" -f index.chm "$RESULTING_HTML_HELP_FILE" - fi - fi - fi -fi - -# ---------------------------------------------------------------------------- -# Create the compressed tar archive. - -if test "x$CREATE_HTML_TARZ_ARCHIVE" == "xON" ; then - if test "x$RESULTING_HTML_TARZ_ARCHIVE_FILE" != "x" ; then - cd "$OUTPUT_DIRECTORY" - if test "x$TAR_PROG" != "xNOTFOUND" ; then - if test "x$RM_PROG" != "xNOTFOUND" ; then - "$RM_PROG" -f html.tar - fi - "$TAR_PROG" -cf html.tar html - if test "x$GZIP_PROG" != "xNOTFOUND" ; then - if test "x$RM_PROG" != "xNOTFOUND" ; then - "$RM_PROG" -f html.tar.gz - fi - "$GZIP_PROG" html.tar - "$MV_PROG" -f html.tar.gz "$RESULTING_HTML_TARZ_ARCHIVE_FILE" - fi - fi - fi -fi - -# ---------------------------------------------------------------------------- -# Clean-up. - -if test "x$RM_PROG" != "xNOTFOUND" ; then - "$RM_PROG" -fr "$INTERMEDIATE_DOX_DIR" - - if test "x$DOWNLOAD_VTK_TAGFILE" == "xON" ; then - if test "x$VTK_TAGFILE" != "x" ; then - "$RM_PROG" -f "$VTK_TAGFILE_DEST_DIR/$VTK_TAGFILE" - fi - fi - - if test "x$COMPILE_HTML_HELP" == "xON" ; then - if test "x$RESULTING_HTML_HELP_FILE" != "x" ; then - if test "x$ALLOW_ERASE_OUTPUT_DIRECTORY" == "xON" ; then - "$RM_PROG" -fr "$OUTPUT_DIRECTORY" - fi - fi - fi -fi diff --git a/Utilities/Doxygen/doxyfile.in b/Utilities/Doxygen/doxyfile.in index 2c131f50b..73333406d 100644 --- a/Utilities/Doxygen/doxyfile.in +++ b/Utilities/Doxygen/doxyfile.in @@ -1,28 +1,30 @@ # ------------------------------------------------------------------------- -# doxyfile for CMake -# modified by S. Barre (Time-stamp: <2002-02-13 18:24:35 barre> +# doxyfile for CMakeReference # ------------------------------------------------------------------------- PROJECT_NAME = CMake +PROJECT_BRIEF = "Cross-platform Make" +PROJECT_NUMBER = "@CMake_VERSION@" +PROJECT_LOGO = "@CMake_SOURCE_DIR@/Source/QtDialog/CMakeSetup64.png" FULL_PATH_NAMES = YES STRIP_FROM_PATH = \ - "@CMake_SOURCE_DIR@/Source/" \ - "@CMake_BINARY_DIR@/Source/" + "@CMake_SOURCE_DIR@/" \ + "@CMake_BINARY_DIR@/" WARN_IF_UNDOCUMENTED = NO GENERATE_TREEVIEW = NO GENERATE_TODOLIST = YES GENERATE_BUGLIST = YES -GENERATE_HTML = YES +GENERATE_HTML = @GENERATE_HTML@ GENERATE_HTMLHELP = YES +GENERATE_QHP = @GENERATE_QHP@ GENERATE_LATEX = NO GENERATE_MAN = NO GENERATE_RTF = NO -HAVE_DOT = YES -#HAVE_DOT = NO +HAVE_DOT = @HAVE_DOT@ DOT_PATH = "@DOT_PATH@" CLASS_GRAPH = YES COLLABORATION_GRAPH = YES @@ -37,20 +39,21 @@ REFERENCES_RELATION = YES ALLEXTERNALS = NO -IMAGE_PATH = "@CMake_BINARY_DIR@/Utilities/Doxygen/contrib" - -OUTPUT_DIRECTORY = "@CMake_BINARY_DIR@/Utilities/Doxygen/doc" +OUTPUT_DIRECTORY = "@CMakeDeveloperReference_BINARY_DIR@/developer-reference" INPUT = \ + "@CMake_SOURCE_DIR@/Utilities/Doxygen/DeveloperReference" \ "@CMake_SOURCE_DIR@/Source" \ "@CMake_SOURCE_DIR@/Source/CPack" \ "@CMake_SOURCE_DIR@/Source/CPack/IFW" \ + "@CMake_SOURCE_DIR@/Source/CPack/WiX" \ "@CMake_SOURCE_DIR@/Source/CTest" \ "@CMake_SOURCE_DIR@/Source/CursesDialog" \ - "@CMake_SOURCE_DIR@/Source/MFCDialog" \ + "@CMake_SOURCE_DIR@/Source/kwsys" \ + "@CMake_SOURCE_DIR@/Source/QtDialog" \ + "@CMake_BINARY_DIR@/Source" \ "@CMake_BINARY_DIR@/Source/kwsys" \ - "@CMake_BINARY_DIR@/Source/cmsys" \ - "@CMake_BINARY_DIR@/Utilities/Doxygen/dox/doc_CMake_contributors.dox" \ + "@CMake_BINARY_DIR@/Source/cmsys" EXTRACT_ALL = YES EXTRACT_PRIVATE = NO @@ -68,7 +71,7 @@ SORT_MEMBER_DOCS = NO DISTRIBUTE_GROUP_DOC = YES TAB_SIZE = 3 -FILE_PATTERNS = *.h *.hxx *.cxx +FILE_PATTERNS = *.h *.hxx *.cxx *.dox RECURSIVE = NO EXCLUDE_PATTERNS = @@ -82,3 +85,7 @@ MACRO_EXPANSION = YES SEARCH_INCLUDES = YES INCLUDE_PATH = EXPAND_ONLY_PREDEF = YES + +QHP_NAMESPACE = org.cmake.developer-reference.@CMake_VERSION_MAJOR@@CMake_VERSION_MINOR@@CMake_VERSION_PATCH@ +QCH_FILE = ../CMakeDeveloperReference-@CMake_VERSION_MAJOR@@CMake_VERSION_MINOR@@CMake_VERSION_PATCH@.qch +QHG_LOCATION = "@QHELPGENERATOR_EXECUTABLE@"