mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
STYLE: foamHelp helpType clean-up
This commit is contained in:
@ -71,8 +71,11 @@ void Foam::helpType::displayDocOptions
|
|||||||
{
|
{
|
||||||
fileName doxyPath(doxygenPath());
|
fileName doxyPath(doxygenPath());
|
||||||
|
|
||||||
if (!doxyPath.empty())
|
if (doxyPath.empty())
|
||||||
{
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl;
|
Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl;
|
||||||
|
|
||||||
doxygenXmlParser parser
|
doxygenXmlParser parser
|
||||||
@ -84,7 +87,6 @@ void Foam::helpType::displayDocOptions
|
|||||||
);
|
);
|
||||||
|
|
||||||
Info<< "Valid types include:" << nl << SortableList<word>(parser.toc());
|
Info<< "Valid types include:" << nl << SortableList<word>(parser.toc());
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@ -97,8 +99,11 @@ void Foam::helpType::displayDoc
|
|||||||
{
|
{
|
||||||
fileName doxyPath(doxygenPath());
|
fileName doxyPath(doxygenPath());
|
||||||
|
|
||||||
if (!doxyPath.empty())
|
if (doxyPath.empty())
|
||||||
{
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl;
|
Info<< "Found doxygen help in " << doxyPath.c_str() << nl << endl;
|
||||||
|
|
||||||
string docBrowser = getEnv("FOAM_DOC_BROWSER");
|
string docBrowser = getEnv("FOAM_DOC_BROWSER");
|
||||||
@ -124,10 +129,7 @@ void Foam::helpType::displayDoc
|
|||||||
|
|
||||||
if (parser.found(className))
|
if (parser.found(className))
|
||||||
{
|
{
|
||||||
fileName docFile
|
fileName docFile(doxyPath/parser.subDict(className).lookup("filename"));
|
||||||
(
|
|
||||||
doxyPath/parser.subDict(className).lookup("filename")
|
|
||||||
);
|
|
||||||
|
|
||||||
// can use FOAM_DOC_BROWSER='application file://%f' if required
|
// can use FOAM_DOC_BROWSER='application file://%f' if required
|
||||||
docBrowser.replaceAll("%f", docFile);
|
docBrowser.replaceAll("%f", docFile);
|
||||||
@ -149,11 +151,9 @@ void Foam::helpType::displayDoc
|
|||||||
"void Foam::helpType::displayDoc(const word, const string)"
|
"void Foam::helpType::displayDoc(const word, const string)"
|
||||||
)
|
)
|
||||||
<< "No help for type " << className << " found."
|
<< "No help for type " << className << " found."
|
||||||
<< " Valid options include:"
|
<< " Valid options include:" << SortableList<word>(parser.toc())
|
||||||
<< SortableList<word>(parser.toc())
|
|
||||||
<< exit(FatalError);
|
<< exit(FatalError);
|
||||||
}
|
}
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user