OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-10 23:46:00 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doc : Updated text for command file markdown generator

Browse Source
This commit is contained in:
Magne Sjaastad 2021-01-18 09:15:13 +01:00
parent 0a6c9143c8
commit 55034759c5
1 changed files with 11 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
ApplicationLibCode/Application/RiaApplication.cpp
View File

@ -1798,24 +1798,18 @@ bool RiaApplication::generateCode( const QString& fileName, gsl::not_null<QStrin
QTextStream out( &outputFile );
{
out << "+++ \n";
out << "title = \"Command Reference (BETA)\" \n";
out << "published = true \n";
out << "weight = 96 \n";
out << "+++ \n";
out << "As the Python interface is growing release by release, we are investigating how to automate "
"the building of reference documentation. This document is not complete, "
"but will improve as the automation moves forward.\n\n";
out << "# Introduction\n\n";
out << "As the Python interface is growing release by release, we are investigating how to "
"automate "
"the building of reference documentation. This document is not complete, but will improve "
"as "
"the automation "
"moves forward.\n";
out << "More details on the command file operations, see "
"https://resinsight.org/scripting/commandfile/\n\n";
out << "## Currently missing features\n\n";
out << " - Description of enums\n";
out << " - Description of return values/classes\n";
out << " - Description of each object\n";
// TODO
// out << "## Currently missing features\n\n";
// out << " - Description of enums\n";
// out << " - Description of return values/classes\n";
// out << " - Description of each object\n\n";
}
std::vector<std::shared_ptr<const caf::PdmObject>> commandObjects;
@ -1823,7 +1817,7 @@ bool RiaApplication::generateCode( const QString& fileName, gsl::not_null<QStrin
QStringList excludedClassNames{ "TestCommand1", "TC2" }; // See RifCommandCore-Text.cpp
auto allObjects = caf::PdmMarkdownBuilder::createAllObjects( caf::PdmDefaultObjectFactory::instance() );
for ( auto classObject : allObjects )
for ( const auto& classObject : allObjects )
{
if ( dynamic_cast<const RicfCommandObject*>( classObject.get() ) )
{