Merge pull request #38771 from mantidproject/37248-PHW-cppcheck-suppr…

…essions-ornl-next Road to removing qtassistant (documentation) --> Cppcheck suppressions removal for HelpWindow - ornl-next
mantidproject · Jan 31, 2025 · 335cf4f · 335cf4f
2 parents edaf021 + 2a806f0
commit 335cf4f
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 26 deletions.
diff --git a/buildconfig/CMake/CppCheck_Suppressions.txt.in b/buildconfig/CMake/CppCheck_Suppressions.txt.in
@@ -1245,18 +1245,6 @@ constVariableReference:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/ImageInfoModelM
 passedByValue:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/ImageInfoPresenter.cpp:33
 constVariableReference:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/InstrumentSelector.cpp:38
 constVariableReference:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/ListPropertyWidget.cpp:46
-constParameterReference:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:301
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:318
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:320
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:329
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:331
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:342
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:343
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:344
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:354
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:355
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:356
-ignoredReturnErrorCode:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidHelpWindow.cpp:357
 iterateByValue:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidTreeModel.cpp:35
 useStlAlgorithm:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidTreeModel.cpp:36
 iterateByValue:${CMAKE_SOURCE_DIR}/qt/widgets/common/src/MantidTreeWidget.cpp:171

diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/MantidHelpWindow.h b/qt/widgets/common/inc/MantidQtWidgets/Common/MantidHelpWindow.h
@@ -25,7 +25,7 @@ class EXPORT_OPT_MANTIDQT_COMMON MantidHelpWindow : public API::MantidHelpInterf
   Q_OBJECT
 
 public:
-  static bool helpWindowExists() { return !g_helpWindow.isNull(); }
+  static bool helpWindowExists();
 
   MantidHelpWindow(const Qt::WindowFlags &flags = Qt::WindowFlags());
 
@@ -55,7 +55,7 @@ class EXPORT_OPT_MANTIDQT_COMMON MantidHelpWindow : public API::MantidHelpInterf
   /// Whether this is the very first startup of the helpwindow.
   bool m_firstRun;
 
-  void findCollectionFile(std::string &binDir);
+  void findCollectionFile(const std::string &binDir);
   void determineFileLocs();
 
 public slots:

diff --git a/qt/widgets/common/src/MantidHelpWindow.cpp b/qt/widgets/common/src/MantidHelpWindow.cpp
@@ -36,7 +36,9 @@ namespace MantidQt::MantidWidgets {
 using std::string;
 using namespace MantidQt::API;
 
+#ifdef DOCS_QTHELP
 REGISTER_HELPWINDOW(MantidHelpWindow)
+#endif
 
 namespace {
 /// static logger
@@ -63,6 +65,8 @@ const QString HTML_BASE_PATH("/");
 /// Page to display if nothing provided
 const QString DEFAULT_PAGENAME("index");
 
+bool MantidHelpWindow::helpWindowExists() { return !g_helpWindow.isNull(); }
+
 /**
  * Default constructor shows the base index page.
  */
@@ -298,7 +302,7 @@ void MantidHelpWindow::shutdown() {
  *
  * @param binDir The location of the mantid executable.
  */
-void MantidHelpWindow::findCollectionFile(std::string &binDir) {
+void MantidHelpWindow::findCollectionFile(const std::string &binDir) {
   // this being empty notes the feature being disabled
   m_collectionFile = "";
 
@@ -315,9 +319,9 @@ void MantidHelpWindow::findCollectionFile(std::string &binDir) {
   }
 
   // try where the builds will put it for a single configuration build
-  searchDir.cdUp();
+  UNUSED_ARG(searchDir.cdUp());
   if (searchDir.cd("docs")) {
-    searchDir.cd("qthelp");
+    UNUSED_ARG(searchDir.cd("qthelp"));
     path = searchDir.absoluteFilePath(COLLECTION_FILE);
     g_log.debug() << "Trying \"" << path.toStdString() << "\"\n";
     if (searchDir.exists(COLLECTION_FILE)) {
@@ -326,9 +330,9 @@ void MantidHelpWindow::findCollectionFile(std::string &binDir) {
     }
   }
   // try where the builds will put it for a multi-configuration build
-  searchDir.cdUp();
+  UNUSED_ARG(searchDir.cdUp());
   if (searchDir.cd("docs")) {
-    searchDir.cd("qthelp");
+    UNUSED_ARG(searchDir.cd("qthelp"));
     path = searchDir.absoluteFilePath(COLLECTION_FILE);
     g_log.debug() << "Trying \"" << path.toStdString() << "\"\n";
     if (searchDir.exists(COLLECTION_FILE)) {
@@ -339,9 +343,9 @@ void MantidHelpWindow::findCollectionFile(std::string &binDir) {
 
   // try in windows/linux install location
   searchDir = QDir(QString::fromStdString(binDir));
-  searchDir.cdUp();
-  searchDir.cd("share");
-  searchDir.cd("doc");
+  UNUSED_ARG(searchDir.cdUp());
+  UNUSED_ARG(searchDir.cd("share"));
+  UNUSED_ARG(searchDir.cd("doc"));
   path = searchDir.absoluteFilePath(COLLECTION_FILE);
   g_log.debug() << "Trying \"" << path.toStdString() << "\"\n";
   if (searchDir.exists(COLLECTION_FILE)) {
@@ -351,10 +355,10 @@ void MantidHelpWindow::findCollectionFile(std::string &binDir) {
 
   // try a special place for mac/osx
   searchDir = QDir(QString::fromStdString(binDir));
-  searchDir.cdUp();
-  searchDir.cdUp();
-  searchDir.cd("share");
-  searchDir.cd("doc");
+  UNUSED_ARG(searchDir.cdUp());
+  UNUSED_ARG(searchDir.cdUp());
+  UNUSED_ARG(searchDir.cd("share"));
+  UNUSED_ARG(searchDir.cd("doc"));
   path = searchDir.absoluteFilePath(COLLECTION_FILE);
   g_log.debug() << "Trying \"" << path.toStdString() << "\"\n";
   if (searchDir.exists(COLLECTION_FILE)) {