From 510af704d8e2f0c65b7d5895148ed397320e39a6 Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Tue, 16 Jan 2018 11:05:30 +0100 Subject: [PATCH] [libcalamares] Improve documentation - reference to _WITH_JSON is bogus copy-replace from other code - fix style of sample code. --- src/libcalamares/utils/PluginFactory.h | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/libcalamares/utils/PluginFactory.h b/src/libcalamares/utils/PluginFactory.h index 456802555..7a55cc711 100644 --- a/src/libcalamares/utils/PluginFactory.h +++ b/src/libcalamares/utils/PluginFactory.h @@ -111,13 +111,11 @@ namespace Calamares * T(QObject *parent, const QVariantList &args) * \endcode * - * You should typically use either CALAMARES_PLUGIN_FACTORY() or - * CALAMARES_PLUGIN_FACTORY_WITH_JSON() in your plugin code to create the factory. The - * typical pattern is + * You should typically use CALAMARES_PLUGIN_FACTORY_DEFINITION() in your plugin code to + * create the factory. The pattern is * * \code - * #include - * #include + * #include "utils/PluginFactory.h" * * class MyPlugin : public PluginInterface * { @@ -127,10 +125,9 @@ namespace Calamares * {} * }; * - * CALAMARES_PLUGIN_FACTORY(MyPluginFactory, + * CALAMARES_PLUGIN_FACTORY_DEFINITION(MyPluginFactory, * registerPlugin(); * ) - * #include * \endcode * * If you want to load a library use KPluginLoader.