Method exportDocs

Engine/AppInstance.cpp:1411–1587

}

void
AppInstance::exportDocs(const QString path)
{
    if ( !path.isEmpty() ) {
        QStringList groups;
        // Group ordering is set at every place in the code where GROUP_ORDER appears in the comments
        groups << QString::fromUtf8(PLUGIN_GROUP_IMAGE);
        groups << QString::fromUtf8(PLUGIN_GROUP_PAINT);
        groups << QString::fromUtf8(PLUGIN_GROUP_TIME);
        groups << QString::fromUtf8(PLUGIN_GROUP_CHANNEL);
        groups << QString::fromUtf8(PLUGIN_GROUP_COLOR);
        groups << QString::fromUtf8(PLUGIN_GROUP_FILTER);
        groups << QString::fromUtf8(PLUGIN_GROUP_KEYER);
        groups << QString::fromUtf8(PLUGIN_GROUP_MERGE);
        groups << QString::fromUtf8(PLUGIN_GROUP_TRANSFORM);
        groups << QString::fromUtf8(PLUGIN_GROUP_MULTIVIEW);
        groups << QString::fromUtf8(PLUGIN_GROUP_OTHER);
        groups << QString::fromUtf8("GMIC"); // openfx-gmic
        groups << QString::fromUtf8("Extra"); // openfx-arena
        QVector<QStringList> plugins;

        // Generate a MD for each plugin
        // IMPORTANT: this code is *very* similar to DocumentationManager::handler(...) is section "_group.html"
        std::list<std::string> pluginIDs = appPTR->getPluginIDs();
        for (std::list<std::string>::iterator it = pluginIDs.begin(); it != pluginIDs.end(); ++it) {
            QString pluginID = QString::fromUtf8( it->c_str() );
            if ( !pluginID.isEmpty() ) {
                Plugin* plugin = 0;
                QString pluginID = QString::fromUtf8( it->c_str() );
                plugin = appPTR->getPluginBinary(pluginID, -1, -1, false);
                if ( plugin && !plugin->getIsDeprecated() && ( !plugin->getIsForInternalUseOnly() || plugin->isReader() || plugin->isWriter() ) ) {
                    QStringList groups = plugin->getGrouping();
                    groups << groups.at(0);
                    QStringList plugList;
                    plugList << plugin->getGrouping().at(0) << pluginID << Plugin::makeLabelWithoutSuffix( plugin->getPluginLabel() );
                    plugins << plugList;
                    CreateNodeArgs args( pluginID.toStdString(), NodeCollectionPtr() );
                    args.setProperty(kCreateNodeArgsPropNoNodeGUI, true);
                    args.setProperty(kCreateNodeArgsPropOutOfProject, true);
                    args.setProperty(kCreateNodeArgsPropSilent, true);
                    qDebug() << pluginID;
                    // IMPORTANT: this code is *very* similar to DocumentationManager::handler(...) is section "_plugin.html"
                    NodePtr node = createNode(args);
                    if ( node &&
                         pluginID != QString::fromUtf8(PLUGINID_NATRON_READ) &&
                         pluginID != QString::fromUtf8(PLUGINID_NATRON_WRITE) ) {
                        EffectInstancePtr effectInstance = node->getEffectInstance();
                        if ( effectInstance && effectInstance->isReader() ) {
                            ReadNode* isReadNode = dynamic_cast<ReadNode*>( effectInstance.get() );

                            if (isReadNode) {
                                NodePtr subnode = isReadNode->getEmbeddedReader();
                                if (subnode) {
                                    node = subnode;
                                }
                            }
                        } else if ( effectInstance && effectInstance->isWriter() ) {
                            WriteNode* isWriteNode = dynamic_cast<WriteNode*>( effectInstance.get() );