zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

check for XXXApp_8C.html (Application) in the -doc argument handling first.

Browse Source 
This is useful when the application has the same name as a class. For example,
polyDualMeshApp.C implements the polyDualMesh application using the
polyDualMesh class. Thus polyDualMeshApp_8C.html documents the app, whereas
polyDualMesh_8C.html is the annotated source code for the class itself.
This commit is contained in:
Mark Olesen
2008-05-21 09:51:34 +02:00
parent e5e89deabd
commit da4495fea8
2 changed files with 33 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
etc/controlDict
View File

@ -5,22 +5,15 @@
| \\ / A nd | Web: http://www.openfoam.org | | \\ / A nd | Web: http://www.openfoam.org |
| \\/ M anipulation | | | \\/ M anipulation | |
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
// Foam Dictionary.
FoamFile FoamFile
{ {
version 2.0; version 2.0;
format ascii; format ascii;
class dictionary;
root ""; object controlDict;
case "";
instance "";
local "";
class dictionary;
object controlDict;
} }
// NB: the #functions do not work here
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
hosts hosts
@ -63,14 +56,18 @@ caseRoots
Documentation Documentation
{ {
docBrowser "kde-open %f"; docBrowser "kde-open %f";
doxyDocDirs doxyDocDirs
( (
"$WM_PROJECT_USER_DIR/Doxygen/html" "$WM_PROJECT_USER_DIR/Doxygen/html"
"~OpenFOAM/Doxygen/html" "~OpenFOAM/Doxygen/html"
"$WM_PROJECT_DIR/doc/Doxygen/html" "$WM_PROJECT_DIR/doc/Doxygen/html"
); );
doxySourceFileExt "_8C.html"; doxySourceFileExts
(
"App_8C.html"
"_8C.html"
);
} }
DebugSwitches DebugSwitches
@ -280,9 +277,9 @@ DebugSwitches
SyamlalRogersOBrien 0; SyamlalRogersOBrien 0;
TAB 0; TAB 0;
ThermoCloud<reactingParcel> 0; ThermoCloud<reactingParcel> 0;
ThermoCloud<thermoParcel> 0; ThermoCloud<thermoParcel> 0;
ThermoParcel<reactingParcel> 0; ThermoParcel<reactingParcel> 0;
ThermoParcel<thermoParcel> 0; ThermoParcel<thermoParcel> 0;
UMIST 0; UMIST 0;
UMISTV 0; UMISTV 0;
Unix 0; Unix 0;
@ -296,8 +293,8 @@ DebugSwitches
addPoint 0; addPoint 0;
advective 0; advective 0;
algebraicPair 0; algebraicPair 0;
angularOscillatingDisplacement 0; angularOscillatingDisplacement 0;
angularOscillatingVelocity 0; angularOscillatingVelocity 0;
anisotropic 0; anisotropic 0;
ash 0; ash 0;
atomizationModel 0; atomizationModel 0;
@ -313,7 +310,7 @@ DebugSwitches
basicThermoCloud 0; basicThermoCloud 0;
binaryAbsorptionEmission 0; binaryAbsorptionEmission 0;
blended 0; blended 0;
blobsSheetAtomization 0; blobsSheetAtomization 0;
blobsSwirlInjector 0; blobsSwirlInjector 0;
booleanSurface 0; booleanSurface 0;
boundaryCutter 0; boundaryCutter 0;
@ -358,8 +355,8 @@ DebugSwitches
conductivityModel 0; conductivityModel 0;
constInjector 0; constInjector 0;
constant 0; constant 0;
constantAbsorptionEmission 0; constantAbsorptionEmission 0;
constantGammaContactAngle 0; constantGammaContactAngle 0;
constantScatter 0; constantScatter 0;
coordinateRotation 0; coordinateRotation 0;
coordinateSystem 0; coordinateSystem 0;
@ -388,7 +385,7 @@ DebugSwitches
disallowDefaultFvsPatchField 0; disallowDefaultFvsPatchField 0;
disallowGenericFvPatchField 0; disallowGenericFvPatchField 0;
disallowGenericPointPatchField 0; disallowGenericPointPatchField 0;
disallowGenericPolyPatch 0; disallowGenericPolyPatch 0;
dispersionLESModel 0; dispersionLESModel 0;
dispersionModel 0; dispersionModel 0;
dispersionRASModel 0; dispersionRASModel 0;

22
src/OpenFOAM/global/argList/argList.C
View File

@ -607,27 +607,33 @@ void Foam::argList::displayDoc() const
{ {
const dictionary& docDict = debug::controlDict().subDict("Documentation"); const dictionary& docDict = debug::controlDict().subDict("Documentation");
List<fileName> docDirs(docDict.lookup("doxyDocDirs")); List<fileName> docDirs(docDict.lookup("doxyDocDirs"));
List<fileName> docExts(docDict.lookup("doxySourceFileExts"));
fileName docFile; fileName docFile;
bool found = false; bool found = false;
forAll(docDirs, dirI) forAll(docDirs, dirI)
{ {
docFile = forAll(docExts, extI)
fileName(docDirs[dirI])/executable() {
+ fileName(docDict.lookup("doxySourceFileExt")); docFile = docDirs[dirI]/executable() + docExts[extI];
docFile.expand(); docFile.expand();
if (exists(docFile)) if (exists(docFile))
{
found = true;
break;
}
}
if (found)
{ {
found = true;
break; break;
} }
} }
if (found) if (found)
{ {
string docBrowser = docDict.lookup("docBrowser"); string docBrowser(docDict.lookup("docBrowser"));
docBrowser.replaceAll("%f", docFile); docBrowser.replaceAll("%f", docFile);
Info<< "Show documentation: " << docBrowser.c_str() << endl; Info<< "Show documentation: " << docBrowser.c_str() << endl;