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

15
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;
root "";
case "";
instance "";
local "";
class dictionary; class dictionary;
object controlDict; object controlDict;
} }
// NB: the #functions do not work here
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
hosts hosts
@ -70,7 +63,11 @@ Documentation
"~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

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

@ -607,15 +607,16 @@ 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))
@ -624,10 +625,15 @@ void Foam::argList::displayDoc() const
break; break;
} }
} }
if (found)
{
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;