Help: Remove functionality of unregistering namespace from public API

Only used by the options page and generally needs knowledge of help
namespaces, which requires querying QtHelp.

Change-Id: Id8eda86e5b373ab3214e8eff6e2e3ce92c1239ba
Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
Eike Ziller
2019-10-04 15:03:39 +02:00
parent f467badc2f
commit 2c2bca924a
6 changed files with 5 additions and 13 deletions

View File

@@ -80,12 +80,6 @@ void registerDocumentation(const QStringList &files)
m_instance->registerDocumentation(files); m_instance->registerDocumentation(files);
} }
void unregisterDocumentation(const QStringList &nameSpaces)
{
if (checkInstance())
m_instance->unregisterDocumentation(nameSpaces);
}
QMap<QString, QUrl> linksForIdentifier(const QString &id) QMap<QString, QUrl> linksForIdentifier(const QString &id)
{ {
return checkInstance() ? m_instance->linksForIdentifier(id) : QMap<QString, QUrl>(); return checkInstance() ? m_instance->linksForIdentifier(id) : QMap<QString, QUrl>();

View File

@@ -61,7 +61,6 @@ enum HelpViewerLocation {
CORE_EXPORT QString documentationPath(); CORE_EXPORT QString documentationPath();
CORE_EXPORT void registerDocumentation(const QStringList &fileNames); CORE_EXPORT void registerDocumentation(const QStringList &fileNames);
CORE_EXPORT void unregisterDocumentation(const QStringList &nameSpaces);
CORE_EXPORT QMap<QString, QUrl> linksForIdentifier(const QString &id); CORE_EXPORT QMap<QString, QUrl> linksForIdentifier(const QString &id);
CORE_EXPORT QMap<QString, QUrl> linksForKeyword(const QString &id); CORE_EXPORT QMap<QString, QUrl> linksForKeyword(const QString &id);

View File

@@ -39,7 +39,6 @@ protected:
public: public:
virtual void registerDocumentation(const QStringList &fileNames) = 0; virtual void registerDocumentation(const QStringList &fileNames) = 0;
virtual void unregisterDocumentation(const QStringList &nameSpaces) = 0;
virtual QMap<QString, QUrl> linksForIdentifier(const QString &id) = 0; virtual QMap<QString, QUrl> linksForIdentifier(const QString &id) = 0;
virtual QMap<QString, QUrl> linksForKeyword(const QString &keyword) = 0; virtual QMap<QString, QUrl> linksForKeyword(const QString &keyword) = 0;
virtual QByteArray fileData(const QUrl &url) = 0; virtual QByteArray fileData(const QUrl &url) = 0;

View File

@@ -27,7 +27,6 @@
#include "helpconstants.h" #include "helpconstants.h"
#include "helpmanager.h" #include "helpmanager.h"
#include <coreplugin/helpmanager.h>
#include <utils/algorithm.h> #include <utils/algorithm.h>
#include <QFileDialog> #include <QFileDialog>
@@ -244,7 +243,7 @@ void DocSettingsPage::addDocumentation()
void DocSettingsPage::apply() void DocSettingsPage::apply()
{ {
Core::HelpManager::unregisterDocumentation(m_filesToUnregister.keys()); HelpManager::unregisterNamespaces(m_filesToUnregister.keys());
QStringList files; QStringList files;
auto it = m_filesToRegisterUserManaged.constBegin(); auto it = m_filesToRegisterUserManaged.constBegin();
while (it != m_filesToRegisterUserManaged.constEnd()) { while (it != m_filesToRegisterUserManaged.constEnd()) {

View File

@@ -172,7 +172,7 @@ void HelpManager::registerDocumentationNow(QFutureInterface<bool> &futureInterfa
futureInterface.reportResult(docsChanged); futureInterface.reportResult(docsChanged);
} }
void HelpManager::unregisterDocumentation(const QStringList &nameSpaces) void HelpManager::unregisterNamespaces(const QStringList &nameSpaces)
{ {
if (d->m_needsSetup) { if (d->m_needsSetup) {
for (const QString &name : nameSpaces) for (const QString &name : nameSpaces)
@@ -372,7 +372,7 @@ void HelpManager::setupHelpManager()
d->cleanUpDocumentation(); d->cleanUpDocumentation();
if (!d->m_nameSpacesToUnregister.isEmpty()) { if (!d->m_nameSpacesToUnregister.isEmpty()) {
m_instance->unregisterDocumentation(Utils::toList(d->m_nameSpacesToUnregister)); m_instance->unregisterNamespaces(Utils::toList(d->m_nameSpacesToUnregister));
d->m_nameSpacesToUnregister.clear(); d->m_nameSpacesToUnregister.clear();
} }

View File

@@ -49,7 +49,8 @@ public:
static QString collectionFilePath(); static QString collectionFilePath();
void registerDocumentation(const QStringList &fileNames) override; void registerDocumentation(const QStringList &fileNames) override;
void unregisterDocumentation(const QStringList &nameSpaces) override;
static void unregisterNamespaces(const QStringList &nameSpaces);
static void registerUserDocumentation(const QStringList &filePaths); static void registerUserDocumentation(const QStringList &filePaths);
static QSet<QString> userDocumentationPaths(); static QSet<QString> userDocumentationPaths();