ENH: More flexible -doc and -srcDoc options using index file
commit6a5612761bbdff121d1dd27111a95f3a32421fa9
authorMichael Wild <themiwi@users.sourceforge.net>
Wed, 3 Jun 2009 16:31:02 +0000 (3 18:31 +0200)
committerMichael Wild <themiwi@users.sourceforge.net>
Thu, 4 Jun 2009 05:39:03 +0000 (4 07:39 +0200)
treef66750a050c4f8a040bac79657be35d2b00b07f6
parentbb4fbe44dd64c52d5773c20f074ba002c6222522
ENH: More flexible -doc and -srcDoc options using index file

argList.C now doesn't search docDirs directly, but uses an index file
for this. This allows also www paths to be referenced. Further, multiple
documentation index files can be specified, each with its own directory
prefix. The "master" documentation index file is created by CMake using
the new FF_ADD_EXECUTABLE_TO_DOC_INDEX function.

The user can now choose to use the online or the local docs
(FF_USE_LOCAL_DOXYGE_DOCS) and if she doesn't want to use a
HTML browser, she can set HTML_DOC_BROWSER to "ECHO" which will cause
FreeFOAM to just output the name and location of the documentation file.

Signed-off-by: Michael Wild <themiwi@users.sourceforge.net>
213 files changed:
CMake/Modules/FFAddExecutableToDocIndex.cmake [new file with mode: 0644]
CMake/Modules/FFConfigureFiles.cmake
CMakeLists.txt
INSTALL
INSTALL.html
applications/solvers/DNS/dnsFoam/CMakeLists.txt
applications/solvers/basic/laplacianFoam/CMakeLists.txt
applications/solvers/basic/potentialFoam/CMakeLists.txt
applications/solvers/basic/scalarTransportFoam/CMakeLists.txt
applications/solvers/combustion/PDRFoam/CMakeLists.txt
applications/solvers/combustion/XiFoam/CMakeLists.txt
applications/solvers/combustion/Xoodles/CMakeLists.txt
applications/solvers/combustion/coldEngineFoam/CMakeLists.txt
applications/solvers/combustion/dieselEngineFoam/CMakeLists.txt
applications/solvers/combustion/dieselFoam/CMakeLists.txt
applications/solvers/combustion/engineFoam/CMakeLists.txt
applications/solvers/combustion/reactingFoam/CMakeLists.txt
applications/solvers/compressible/coodles/CMakeLists.txt
applications/solvers/compressible/rhoCentralFoam/CMakeLists.txt
applications/solvers/compressible/rhoPimpleFoam/CMakeLists.txt
applications/solvers/compressible/rhoPorousSimpleFoam/CMakeLists.txt
applications/solvers/compressible/rhoSimpleFoam/CMakeLists.txt
applications/solvers/compressible/rhoSonicFoam/CMakeLists.txt
applications/solvers/compressible/rhoTurbFoam/CMakeLists.txt
applications/solvers/compressible/rhopSonicFoam/CMakeLists.txt
applications/solvers/compressible/sonicFoam/CMakeLists.txt
applications/solvers/compressible/sonicFoamAutoMotion/CMakeLists.txt
applications/solvers/compressible/sonicLiquidFoam/CMakeLists.txt
applications/solvers/compressible/sonicTurbFoam/CMakeLists.txt
applications/solvers/electromagnetics/electrostaticFoam/CMakeLists.txt
applications/solvers/electromagnetics/mhdFoam/CMakeLists.txt
applications/solvers/financial/financialFoam/CMakeLists.txt
applications/solvers/heatTransfer/buoyantFoam/CMakeLists.txt
applications/solvers/heatTransfer/buoyantSimpleFoam/CMakeLists.txt
applications/solvers/heatTransfer/buoyantSimpleRadiationFoam/CMakeLists.txt
applications/solvers/heatTransfer/chtMultiRegionFoam/CMakeLists.txt
applications/solvers/heatTransfer/lesBuoyantFoam/CMakeLists.txt
applications/solvers/incompressible/boundaryFoam/CMakeLists.txt
applications/solvers/incompressible/channelOodles/CMakeLists.txt
applications/solvers/incompressible/icoDyMFoam/CMakeLists.txt
applications/solvers/incompressible/icoFoam/CMakeLists.txt
applications/solvers/incompressible/nonNewtonianIcoFoam/CMakeLists.txt
applications/solvers/incompressible/oodles/CMakeLists.txt
applications/solvers/incompressible/simpleFoam/CMakeLists.txt
applications/solvers/incompressible/turbDyMFoam/CMakeLists.txt
applications/solvers/incompressible/turbFoam/CMakeLists.txt
applications/solvers/molecularDynamics/gnemdFoam/CMakeLists.txt
applications/solvers/molecularDynamics/mdEquilibrationFoam/CMakeLists.txt
applications/solvers/multiphase/bubbleFoam/CMakeLists.txt
applications/solvers/multiphase/compressibleLesInterFoam/CMakeLists.txt
applications/solvers/multiphase/interDyMFoam/CMakeLists.txt
applications/solvers/multiphase/interFoam/CMakeLists.txt
applications/solvers/multiphase/interPhaseChangeFoam/CMakeLists.txt
applications/solvers/multiphase/lesCavitatingFoam/CMakeLists.txt
applications/solvers/multiphase/lesInterFoam/CMakeLists.txt
applications/solvers/multiphase/multiphaseInterFoam/CMakeLists.txt
applications/solvers/multiphase/rasCavitatingFoam/CMakeLists.txt
applications/solvers/multiphase/rasInterFoam/CMakeLists.txt
applications/solvers/multiphase/settlingFoam/CMakeLists.txt
applications/solvers/multiphase/twoLiquidMixingFoam/CMakeLists.txt
applications/solvers/multiphase/twoPhaseEulerFoam/CMakeLists.txt
applications/solvers/stressAnalysis/solidDisplacementFoam/CMakeLists.txt
applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/CMakeLists.txt
applications/utilities/errorEstimation/estimateScalarError/CMakeLists.txt
applications/utilities/errorEstimation/icoErrorEstimate/CMakeLists.txt
applications/utilities/errorEstimation/icoMomentError/CMakeLists.txt
applications/utilities/errorEstimation/momentScalarError/CMakeLists.txt
applications/utilities/mesh/advanced/autoRefineMesh/CMakeLists.txt
applications/utilities/mesh/advanced/collapseEdges/CMakeLists.txt
applications/utilities/mesh/advanced/combinePatchFaces/CMakeLists.txt
applications/utilities/mesh/advanced/modifyMesh/CMakeLists.txt
applications/utilities/mesh/advanced/refineHexMesh/CMakeLists.txt
applications/utilities/mesh/advanced/refineWallLayer/CMakeLists.txt
applications/utilities/mesh/advanced/refinementLevel/CMakeLists.txt
applications/utilities/mesh/advanced/removeFaces/CMakeLists.txt
applications/utilities/mesh/advanced/selectCells/CMakeLists.txt
applications/utilities/mesh/advanced/splitCells/CMakeLists.txt
applications/utilities/mesh/conversion/Optional/ccm26ToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/ansysToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/cfx4ToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/fluent3DMeshToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/fluentMeshToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/foamMeshToFluent/CMakeLists.txt
applications/utilities/mesh/conversion/foamToStarMesh/CMakeLists.txt
applications/utilities/mesh/conversion/gambitToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/gmshToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/ideasUnvToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/kivaToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/mshToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/netgenNeutralToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/plot3dToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/polyDualMesh/CMakeLists.txt
applications/utilities/mesh/conversion/sammToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/star4ToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/starToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/tetgenToFoam/CMakeLists.txt
applications/utilities/mesh/conversion/writeMeshObj/CMakeLists.txt
applications/utilities/mesh/generation/blockMesh/CMakeLists.txt
applications/utilities/mesh/generation/extrude2DMesh/CMakeLists.txt
applications/utilities/mesh/generation/extrudeMesh/CMakeLists.txt
applications/utilities/mesh/generation/snappyHexMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/attachMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/autoPatch/CMakeLists.txt
applications/utilities/mesh/manipulation/cellSet/CMakeLists.txt
applications/utilities/mesh/manipulation/checkMesh.save/CMakeLists.txt
applications/utilities/mesh/manipulation/checkMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/createBaffles/CMakeLists.txt
applications/utilities/mesh/manipulation/createPatch/CMakeLists.txt
applications/utilities/mesh/manipulation/deformedGeom/CMakeLists.txt
applications/utilities/mesh/manipulation/faceSet/CMakeLists.txt
applications/utilities/mesh/manipulation/flattenMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/insideCells/CMakeLists.txt
applications/utilities/mesh/manipulation/mergeMeshes/CMakeLists.txt
applications/utilities/mesh/manipulation/mergeOrSplitBaffles/CMakeLists.txt
applications/utilities/mesh/manipulation/mirrorMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/moveDynamicMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/moveEngineMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/moveMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/objToVTK/CMakeLists.txt
applications/utilities/mesh/manipulation/pointSet/CMakeLists.txt
applications/utilities/mesh/manipulation/refineMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/renumberMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/rotateMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/setSet/CMakeLists.txt
applications/utilities/mesh/manipulation/setsToZones/CMakeLists.txt
applications/utilities/mesh/manipulation/splitMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/splitMeshRegions/CMakeLists.txt
applications/utilities/mesh/manipulation/stitchMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/subsetMesh/CMakeLists.txt
applications/utilities/mesh/manipulation/transformPoints/CMakeLists.txt
applications/utilities/mesh/manipulation/zipUpMesh/CMakeLists.txt
applications/utilities/miscellaneous/expandDictionary/CMakeLists.txt
applications/utilities/miscellaneous/foamDebugSwitches/CMakeLists.txt
applications/utilities/miscellaneous/foamFormatConvert/CMakeLists.txt
applications/utilities/miscellaneous/foamInfoExec/CMakeLists.txt
applications/utilities/miscellaneous/patchSummary/CMakeLists.txt
applications/utilities/parallelProcessing/decomposePar/CMakeLists.txt
applications/utilities/parallelProcessing/reconstructPar/CMakeLists.txt
applications/utilities/parallelProcessing/reconstructParMesh/CMakeLists.txt
applications/utilities/parallelProcessing/redistributeMeshPar/CMakeLists.txt
applications/utilities/postProcessing/dataConversion/foamDataToFluent/CMakeLists.txt
applications/utilities/postProcessing/dataConversion/foamToEnsight/CMakeLists.txt
applications/utilities/postProcessing/dataConversion/foamToEnsightParts/CMakeLists.txt
applications/utilities/postProcessing/dataConversion/foamToFieldview9/CMakeLists.txt
applications/utilities/postProcessing/dataConversion/foamToGMV/CMakeLists.txt
applications/utilities/postProcessing/dataConversion/foamToVTK/CMakeLists.txt
applications/utilities/postProcessing/dataConversion/smapToFoam/CMakeLists.txt
applications/utilities/postProcessing/foamCalc/CMakeLists.txt
applications/utilities/postProcessing/miscellaneous/engineCompRatio/CMakeLists.txt
applications/utilities/postProcessing/miscellaneous/execFlowFunctionObjects/CMakeLists.txt
applications/utilities/postProcessing/miscellaneous/pdfPlot/CMakeLists.txt
applications/utilities/postProcessing/miscellaneous/postChannel/CMakeLists.txt
applications/utilities/postProcessing/miscellaneous/ptot/CMakeLists.txt
applications/utilities/postProcessing/miscellaneous/wdot/CMakeLists.txt
applications/utilities/postProcessing/miscellaneous/writeCellCentres/CMakeLists.txt
applications/utilities/postProcessing/patch/patchAverage/CMakeLists.txt
applications/utilities/postProcessing/patch/patchIntegrate/CMakeLists.txt
applications/utilities/postProcessing/sampling/probeLocations/CMakeLists.txt
applications/utilities/postProcessing/sampling/sample/CMakeLists.txt
applications/utilities/postProcessing/scalarField/pPrime2/CMakeLists.txt
applications/utilities/postProcessing/stressField/stressComponents/CMakeLists.txt
applications/utilities/postProcessing/turbulence/R/CMakeLists.txt
applications/utilities/postProcessing/turbulence/createTurbulenceFields/CMakeLists.txt
applications/utilities/postProcessing/velocityField/Co/CMakeLists.txt
applications/utilities/postProcessing/velocityField/Lambda2/CMakeLists.txt
applications/utilities/postProcessing/velocityField/Mach/CMakeLists.txt
applications/utilities/postProcessing/velocityField/Pe/CMakeLists.txt
applications/utilities/postProcessing/velocityField/Q/CMakeLists.txt
applications/utilities/postProcessing/velocityField/enstrophy/CMakeLists.txt
applications/utilities/postProcessing/velocityField/flowType/CMakeLists.txt
applications/utilities/postProcessing/velocityField/streamFunction/CMakeLists.txt
applications/utilities/postProcessing/velocityField/uprime/CMakeLists.txt
applications/utilities/postProcessing/velocityField/vorticity/CMakeLists.txt
applications/utilities/postProcessing/wall/wallGradU/CMakeLists.txt
applications/utilities/postProcessing/wall/wallHeatFlux/CMakeLists.txt
applications/utilities/postProcessing/wall/wallShearStress/CMakeLists.txt
applications/utilities/postProcessing/wall/yPlusLES/CMakeLists.txt
applications/utilities/postProcessing/wall/yPlusRAS/CMakeLists.txt
applications/utilities/preProcessing/applyBoundaryLayer/CMakeLists.txt
applications/utilities/preProcessing/boxTurb/CMakeLists.txt
applications/utilities/preProcessing/changeDictionary/CMakeLists.txt
applications/utilities/preProcessing/engineSwirl/CMakeLists.txt
applications/utilities/preProcessing/mapFields/CMakeLists.txt
applications/utilities/preProcessing/molConfig/CMakeLists.txt
applications/utilities/preProcessing/setFields/CMakeLists.txt
applications/utilities/surface/surfaceAdd/CMakeLists.txt
applications/utilities/surface/surfaceAutoPatch/CMakeLists.txt
applications/utilities/surface/surfaceCheck/CMakeLists.txt
applications/utilities/surface/surfaceClean/CMakeLists.txt
applications/utilities/surface/surfaceCoarsen/CMakeLists.txt
applications/utilities/surface/surfaceConvert/CMakeLists.txt
applications/utilities/surface/surfaceFeatureConvert/CMakeLists.txt
applications/utilities/surface/surfaceFeatureExtract/CMakeLists.txt
applications/utilities/surface/surfaceFind/CMakeLists.txt
applications/utilities/surface/surfaceMeshTriangulate/CMakeLists.txt
applications/utilities/surface/surfaceOrient/CMakeLists.txt
applications/utilities/surface/surfacePointMerge/CMakeLists.txt
applications/utilities/surface/surfaceRefineRedGreen/CMakeLists.txt
applications/utilities/surface/surfaceSmooth/CMakeLists.txt
applications/utilities/surface/surfaceSplitByPatch/CMakeLists.txt
applications/utilities/surface/surfaceSplitNonManifolds/CMakeLists.txt
applications/utilities/surface/surfaceSubset/CMakeLists.txt
applications/utilities/surface/surfaceToPatch/CMakeLists.txt
applications/utilities/surface/surfaceTransformPoints/CMakeLists.txt
applications/utilities/thermophysical/adiabaticFlameT/CMakeLists.txt
applications/utilities/thermophysical/chemkinToFoam/CMakeLists.txt
applications/utilities/thermophysical/equilibriumCO/CMakeLists.txt
applications/utilities/thermophysical/equilibriumFlameT/CMakeLists.txt
applications/utilities/thermophysical/mixtureAdiabaticFlameT/CMakeLists.txt
etc/controlDict.in
src/OpenFOAM/global/argList/argList.C
src/OpenFOAM/global/foamVersion.H
src/OpenFOAM/global/global.C.in