From b9db5ea86e30b57f48b757de30f71f5c0a9bd525 Mon Sep 17 00:00:00 2001 From: Eike Ziller Date: Wed, 19 Sep 2018 14:39:46 +0200 Subject: [PATCH] Move documentationPath() from Core::ICore to Core::HelpManager It is documentation related API, so it belongs there. Change-Id: I5d1676f251e6deb92050ddedac19bf3c332aab54 Reviewed-by: Jarek Kobus Reviewed-by: Tim Jenssen --- src/plugins/coreplugin/helpmanager.cpp | 7 +++++++ src/plugins/coreplugin/helpmanager.h | 2 ++ src/plugins/coreplugin/icore.cpp | 5 ----- src/plugins/coreplugin/icore.h | 1 - src/plugins/help/helpplugin.cpp | 2 +- src/plugins/qbsprojectmanager/qbsprojectmanagerplugin.cpp | 2 +- 6 files changed, 11 insertions(+), 8 deletions(-) diff --git a/src/plugins/coreplugin/helpmanager.cpp b/src/plugins/coreplugin/helpmanager.cpp index a27b1499b3e..e5db350e99a 100644 --- a/src/plugins/coreplugin/helpmanager.cpp +++ b/src/plugins/coreplugin/helpmanager.cpp @@ -30,6 +30,8 @@ #include #include +#include +#include #include namespace Core { @@ -67,6 +69,11 @@ Implementation::~Implementation() m_instance = nullptr; } +QString documentationPath() +{ + return QDir::cleanPath(QCoreApplication::applicationDirPath() + '/' + RELATIVE_DOC_PATH); +} + void registerDocumentation(const QStringList &files) { if (checkInstance()) diff --git a/src/plugins/coreplugin/helpmanager.h b/src/plugins/coreplugin/helpmanager.h index 60bb412752f..a97f65b362f 100644 --- a/src/plugins/coreplugin/helpmanager.h +++ b/src/plugins/coreplugin/helpmanager.h @@ -58,6 +58,8 @@ enum HelpViewerLocation { ExternalHelpAlways = 3 }; +CORE_EXPORT QString documentationPath(); + CORE_EXPORT void registerDocumentation(const QStringList &fileNames); CORE_EXPORT void unregisterDocumentation(const QStringList &nameSpaces); diff --git a/src/plugins/coreplugin/icore.cpp b/src/plugins/coreplugin/icore.cpp index f88f0f8df44..f16f4369bb2 100644 --- a/src/plugins/coreplugin/icore.cpp +++ b/src/plugins/coreplugin/icore.cpp @@ -445,11 +445,6 @@ QString ICore::installerResourcePath() + Constants::IDE_ID; } -QString ICore::documentationPath() -{ - return QDir::cleanPath(QCoreApplication::applicationDirPath() + '/' + RELATIVE_DOC_PATH); -} - /*! Returns the path to the command line tools that are shipped with \QC (corresponding to the IDE_LIBEXEC_PATH qmake variable). diff --git a/src/plugins/coreplugin/icore.h b/src/plugins/coreplugin/icore.h index 37ce9b05dd8..80e387658f4 100644 --- a/src/plugins/coreplugin/icore.h +++ b/src/plugins/coreplugin/icore.h @@ -95,7 +95,6 @@ public: static QString resourcePath(); static QString userResourcePath(); static QString installerResourcePath(); - static QString documentationPath(); static QString libexecPath(); static QString clangExecutable(const QString &clangBinDirectory); static QString clangIncludeDirectory(const QString &clangVersion, diff --git a/src/plugins/help/helpplugin.cpp b/src/plugins/help/helpplugin.cpp index 2ce03e0789f..ea1b229236e 100644 --- a/src/plugins/help/helpplugin.cpp +++ b/src/plugins/help/helpplugin.cpp @@ -329,7 +329,7 @@ void HelpPlugin::extensionsInitialized() { QStringList filesToRegister; // we might need to register creators inbuild help - filesToRegister.append(ICore::documentationPath() + "/qtcreator.qch"); + filesToRegister.append(Core::HelpManager::documentationPath() + "/qtcreator.qch"); Core::HelpManager::registerDocumentation(filesToRegister); } diff --git a/src/plugins/qbsprojectmanager/qbsprojectmanagerplugin.cpp b/src/plugins/qbsprojectmanager/qbsprojectmanagerplugin.cpp index b235d7e3598..4aac91bad63 100644 --- a/src/plugins/qbsprojectmanager/qbsprojectmanagerplugin.cpp +++ b/src/plugins/qbsprojectmanager/qbsprojectmanagerplugin.cpp @@ -111,7 +111,7 @@ bool QbsProjectManagerPlugin::initialize(const QStringList &arguments, QString * const Core::Context projectContext(::QbsProjectManager::Constants::PROJECT_ID); Core::FileIconProvider::registerIconOverlayForSuffix(ProjectExplorer::Constants::FILEOVERLAY_QT, "qbs"); - Core::HelpManager::registerDocumentation({Core::ICore::documentationPath() + "/qbs.qch"}); + Core::HelpManager::registerDocumentation({Core::HelpManager::documentationPath() + "/qbs.qch"}); ProjectManager::registerProjectType(QmlJSTools::Constants::QBS_MIMETYPE); KitManager::registerKitInformation();