From 143e7bf8b167a9a2d0c3b5ef5afc01766b39c0f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Marjam=C3=A4ki?= Date: Sun, 2 Oct 2016 18:23:51 +0200 Subject: [PATCH] GUI: Formatting comments --- gui/mainwindow.h | 470 ++++++++++++++++------------------------------- 1 file changed, 161 insertions(+), 309 deletions(-) diff --git a/gui/mainwindow.h b/gui/mainwindow.h index 4783f6bf9..2c5a551fd 100644 --- a/gui/mainwindow.h +++ b/gui/mainwindow.h @@ -42,16 +42,16 @@ class QAction; /// @{ /** -* @brief Main window for cppcheck-gui -* -*/ + * @brief Main window for cppcheck-gui + * + */ class MainWindow : public QMainWindow { Q_OBJECT public: /** - * @brief Maximum number of MRU project items in File-menu. - */ + * @brief Maximum number of MRU project items in File-menu. + */ enum { MaxRecentProjects = 5 }; MainWindow(TranslationHandler* th, QSettings* settings); @@ -63,273 +63,174 @@ public: Platforms mPlatforms; /** - * @brief Checks given code - * - * @param code Content of the (virtual) file to be checked - * @param filename Name of the (virtual) file to be checked - determines language. - */ + * @brief Checks given code + * + * @param code Content of the (virtual) file to be checked + * @param filename Name of the (virtual) file to be checked - determines language. + */ void CheckCode(const QString& code, const QString& filename); public slots: - /** - * @brief Slot for check files menu item - * - */ + /** @brief Slot for check files menu item */ void CheckFiles(); - /** - * @brief Slot to recheck all files - * - */ + /** @brief Slot to recheck all files */ void ReCheckAll(); /** - * @brief Slot to recheck selected files - * @param selectedFilesList list of selected files - */ + * @brief Slot to recheck selected files + * @param selectedFilesList list of selected files + */ void PerformSelectedFilesCheck(QStringList selectedFilesList); - /** - * @brief Slot to recheck modified files - * - */ + /** @brief Slot to recheck modified files */ void ReCheckModified(); - /** - * @brief Slot to clear all search results - * - */ + /** @brief Slot to clear all search results */ void ClearResults(); - /** - * @brief Slot to open XML report file - * - */ + /** @brief Slot to open XML report file */ void OpenResults(); /** - * @brief Show errors with type "style" - * @param checked Should errors be shown (true) or hidden (false) - */ + * @brief Show errors with type "style" + * @param checked Should errors be shown (true) or hidden (false) + */ void ShowStyle(bool checked); /** - * @brief Show errors with type "error" - * @param checked Should errors be shown (true) or hidden (false) - */ + * @brief Show errors with type "error" + * @param checked Should errors be shown (true) or hidden (false) + */ void ShowErrors(bool checked); /** - * @brief Show errors with type "warning" - * @param checked Should errors be shown (true) or hidden (false) - */ + * @brief Show errors with type "warning" + * @param checked Should errors be shown (true) or hidden (false) + */ void ShowWarnings(bool checked); /** - * @brief Show errors with type "portability" - * @param checked Should errors be shown (true) or hidden (false) - */ + * @brief Show errors with type "portability" + * @param checked Should errors be shown (true) or hidden (false) + */ void ShowPortability(bool checked); /** - * @brief Show errors with type "performance" - * @param checked Should errors be shown (true) or hidden (false) - */ + * @brief Show errors with type "performance" + * @param checked Should errors be shown (true) or hidden (false) + */ void ShowPerformance(bool checked); /** - * @brief Show errors with type "information" - * @param checked Should errors be shown (true) or hidden (false) - */ + * @brief Show errors with type "information" + * @param checked Should errors be shown (true) or hidden (false) + */ void ShowInformation(bool checked); - /** - * @brief Slot to check all "Show errors" menu items - */ + /** @brief Slot to check all "Show errors" menu items */ void CheckAll(); - /** - * @brief Slot to uncheck all "Show errors" menu items - */ + /** @brief Slot to uncheck all "Show errors" menu items */ void UncheckAll(); - /** - * @brief Slot for check directory menu item - * - */ + /** @brief Slot for check directory menu item */ void CheckDirectory(); - /** - * @brief Slot to open program's settings dialog - * - */ + /** @brief Slot to open program's settings dialog */ void ProgramSettings(); - /** - * @brief Slot to open program's about dialog - * - */ + /** @brief Slot to open program's about dialog */ void About(); - /** - * @brief Slot to to show license text - * - */ + /** @brief Slot to to show license text */ void ShowLicense(); - /** - * @brief Slot to to show authors list - * - */ + /** @brief Slot to to show authors list */ void ShowAuthors(); - /** - * @brief Slot to stop processing files - * - */ + /** @brief Slot to save results */ void Save(); - /** - * @brief Slot to create new project file - * - */ + /** @brief Slot to create new project file */ void NewProjectFile(); - /** - * @brief Slot to open project file and start checking contained paths. - * - */ + /** @brief Slot to open project file and start checking contained paths. */ void OpenProjectFile(); - /** - * @brief Slot to open project file and start checking contained paths. - * - */ + /** @brief Slot to show scratchpad. */ void ShowScratchpad(); - /** - * @brief Slot to close open project file. - * - */ + /** @brief Slot to close open project file. */ void CloseProjectFile(); - /** - * @brief Slot to edit project file. - * - */ + /** @brief Slot to edit project file. */ void EditProjectFile(); - /** - * @brief Slot for showing the log view. - * - */ + /** @brief Slot for showing the log view. */ void ShowLogView(); - /** - * @brief Slot for showing the scan and project statistics. - * - */ + /** @brief Slot for showing the scan and project statistics. */ void ShowStatistics(); - /** - * @brief Slot for showing the library editor - * - */ + /** @brief Slot for showing the library editor */ void ShowLibraryEditor(); protected slots: - /** - * @brief Slot for checkthread's done signal - * - */ + /** @brief Slot for checkthread's done signal */ void CheckDone(); - /** - * @brief Lock down UI while checking - * - */ + /** @brief Lock down UI while checking */ void CheckLockDownUI(); - /** - * @brief Slot for enabling save and clear button - * - */ + /** @brief Slot for enabling save and clear button */ void ResultsAdded(); - /** - * @brief Slot for showing/hiding standard toolbar - */ + /** @brief Slot for showing/hiding standard toolbar */ void ToggleMainToolBar(); - /** - * @brief Slot for showing/hiding Categories toolbar - */ + /** @brief Slot for showing/hiding Categories toolbar */ void ToggleViewToolBar(); - /** - * @brief Slot for showing/hiding Filter toolbar - */ + /** @brief Slot for showing/hiding Filter toolbar */ void ToggleFilterToolBar(); - /** - * @brief Slot for updating View-menu before it is shown. - */ + /** @brief Slot for updating View-menu before it is shown. */ void AboutToShowViewMenu(); - /** - * @brief Slot when stop checking button is pressed - * - */ + /** @brief Slot when stop checking button is pressed */ void StopChecking(); - /** - * @brief Open help file contents - * - */ + /** @brief Open help file contents */ void OpenHelpContents(); - /** - * @brief Add new line to log. - * - */ + /** @brief Add new line to log. */ void Log(const QString &logline); - /** - * @brief Handle new debug error. - * - */ + /** @brief Handle new debug error. */ void DebugError(const ErrorItem &item); - /** - * @brief Filters the results in the result list. - */ + /** @brief Filters the results in the result list. */ void FilterResults(); - /** - * @brief Opens recently opened project file. - */ + /** @brief Opens recently opened project file. */ void OpenRecentProject(); - /** - * @brief Selects the platform as checked platform. - */ + /** @brief Selects the platform as checked platform. */ void SelectPlatform(); private: - /** - * @brief Rechecks files - * - */ + /** @brief Rechecks files */ void ReCheck(bool all); /** - * @brief Recheck selected files - * @param files list of selected files - * @param all true if all files of list, false if modified files of list - */ + * @brief Recheck selected files + * @param files list of selected files + * @param all true if all files of list, false if modified files of list + */ void ReCheckSelected(QStringList files, bool all); /** @@ -339,127 +240,113 @@ private: void CheckProject(Project *project); /** - * @brief Set current language - * @param code Language code of the language to set (e.g. "en"). - */ + * @brief Set current language + * @param code Language code of the language to set (e.g. "en"). + */ void SetLanguage(const QString &code); - /** - * @brief Event coming when application is about to close. - */ + /** @brief Event coming when application is about to close. */ virtual void closeEvent(QCloseEvent *event); /** - * @brief Helper function to toggle all show error menu items - * @param checked Should all errors be shown (true) or hidden (false) - */ + * @brief Helper function to toggle all show error menu items + * @param checked Should all errors be shown (true) or hidden (false) + */ void ToggleAllChecked(bool checked); - /** - * @brief Helper function to enable/disable all check,recheck buttons - * - */ + /** @brief Helper function to enable/disable all check,recheck buttons */ void EnableCheckButtons(bool enable); /** - * @brief Select files/or directory to check. - * Helper function to open a dialog to ask user to select files or - * directory to check. Use native dialogs instead of Qt:s own dialogs. - * - * @param mode Dialog open mode (files or directories) - * @return QStringList of files or directories that were selected to check - */ + * @brief Select files/or directory to check. + * Helper function to open a dialog to ask user to select files or + * directory to check. Use native dialogs instead of Qt:s own dialogs. + * + * @param mode Dialog open mode (files or directories) + * @return QStringList of files or directories that were selected to check + */ QStringList SelectFilesToCheck(QFileDialog::FileMode mode); /** - * @brief Check project - * - * @param p imported project - */ + * @brief Check project + * @param p imported project + */ void DoCheckProject(ImportProject p); /** - * @brief Check all files specified in parameter files - * - * @param files List of files and/or directories to check - */ + * @brief Check all files specified in parameter files + * + * @param files List of files and/or directories to check + */ void DoCheckFiles(const QStringList &files); /** - * @brief Get our default cppcheck settings and read project file. - * - * @return Default cppcheck settings - */ + * @brief Get our default cppcheck settings and read project file. + * + * @return Default cppcheck settings + */ Settings GetCppcheckSettings(); - /** - * @brief Load program settings - * - */ + /** @brief Load program settings */ void LoadSettings(); - /** - * @brief Save program settings - * - */ + /** @brief Save program settings */ void SaveSettings() const; /** - * @brief Format main window title. - * @param text Text added to end of the title. - */ + * @brief Format main window title. + * @param text Text added to end of the title. + */ void FormatAndSetTitle(const QString &text = QString()); - /** - * @brief Show help contents - */ + /** @brief Show help contents */ void OpenOnlineHelp(); /** - * @brief Enable or disable project file actions. - * Project editing and closing actions should be only enabled when project is - * open and we are not checking files. - * @param enable If true then actions are enabled. - */ + * @brief Enable or disable project file actions. + * Project editing and closing actions should be only enabled when project is + * open and we are not checking files. + * @param enable If true then actions are enabled. + */ void EnableProjectActions(bool enable); /** - * @brief Enable or disable project file actions. - * Project opening and creating actions should be disabled when checking. - * @param enable If true then actions are enabled. - */ + * @brief Enable or disable project file actions. + * Project opening and creating actions should be disabled when checking. + * @param enable If true then actions are enabled. + */ void EnableProjectOpenActions(bool enable); /** - * @brief Add include directories. - * @param includeDirs List of include directories to add. - * @param result Settings class where include directories are added. - */ + * @brief Add include directories. + * @param includeDirs List of include directories to add. + * @param result Settings class where include directories are added. + */ void AddIncludeDirs(const QStringList &includeDirs, Settings &result); /** - * @brief Handle command line parameters given to GUI. - * @param params List of string given to command line. - */ + * @brief Handle command line parameters given to GUI. + * @param params List of string given to command line. + */ void HandleCLIParams(const QStringList ¶ms); /** - * @brief Load XML file to the GUI. - * @param file Filename (inc. path) of XML file to load. - */ + * @brief Load XML file to the GUI. + * @param file Filename (inc. path) of XML file to load. + */ void LoadResults(const QString file); /** - * @brief Load XML file to the GUI. - * @param file Filename (inc. path) of XML file to load. - * @param checkedDirectory Path to the directory that the results were generated for. - */ + * @brief Load XML file to the GUI. + * @param file Filename (inc. path) of XML file to load. + * @param checkedDirectory Path to the directory that the results were generated for. + */ void LoadResults(const QString file, const QString checkedDirectory); /** - * @brief Load project file to the GUI. - * @param filePath Filename (inc. path) of project file to load. - */ + * @brief Load project file to the GUI. + * @param filePath Filename (inc. path) of project file to load. + */ void LoadProjectFile(const QString &filePath); /** @@ -471,115 +358,80 @@ private: Library::Error LoadLibrary(Library *library, QString filename); /** - * @brief Tries to load library file, prints message on error - * @param library library to use - * @param filename filename (no path) - * @return True if no error - */ + * @brief Tries to load library file, prints message on error + * @param library library to use + * @param filename filename (no path) + * @return True if no error + */ bool TryLoadLibrary(Library *library, QString filename); /** - * @brief Update project MRU items in File-menu. - */ + * @brief Update project MRU items in File-menu. + */ void UpdateMRUMenuItems(); /** - * @brief Add project file (path) to the MRU list. - * @param project Full path to the project file to add. - */ + * @brief Add project file (path) to the MRU list. + * @param project Full path to the project file to add. + */ void AddProjectMRU(const QString &project); /** - * @brief Remove project file (path) from the MRU list. - * @param project Full path of the project file to remove. - */ + * @brief Remove project file (path) from the MRU list. + * @param project Full path of the project file to remove. + */ void RemoveProjectMRU(const QString &project); - /** - * @brief Program settings - * - */ + /** @brief Program settings */ QSettings *mSettings; - /** - * @brief Thread to check files - * - */ + /** @brief Thread to check files */ ThreadHandler *mThread; - /** - * @brief List of user defined applications to open errors with - * - */ + /** @brief List of user defined applications to open errors with */ ApplicationList *mApplications; - /** - * @brief Class to handle translation changes - * - */ + /** @brief Class to handle translation changes */ TranslationHandler *mTranslation; - /** - * @brief Class holding all UI components - * - */ + /** @brief Class holding all UI components */ Ui::MainWindow mUI; - /** - * @brief Current checked directory. - */ + /** @brief Current checked directory. */ QString mCurrentDirectory; - /** - * @brief Log view. - */ + /** @brief Log view. */ LogView *mLogView; - /** - * @brief Scratchpad. - */ + /** @brief Scratchpad. */ ScratchPad* mScratchPad; - /** - * @brief Project (file). - */ + /** @brief Project (file). */ Project *mProject; - /** - * @brief Filter field in the Filter toolbar. - */ + /** @brief Filter field in the Filter toolbar. */ QLineEdit* mLineEditFilter; - /** - * @brief Timer to delay filtering while typing. - */ + /** @brief Timer to delay filtering while typing. */ QTimer* mFilterTimer; - /** - * @brief GUI actions for selecting the checked platform. - */ + /** @brief GUI actions for selecting the checked platform. */ QActionGroup *mPlatformActions; - /** - * @brief GUI actions for selecting the coding standard. - */ + /** @brief GUI actions for selecting the coding standard. */ QActionGroup *mCStandardActions, *mCppStandardActions; - /** - * @brief GUI actions for selecting language. - */ + /** @brief GUI actions for selecting language. */ QActionGroup *mSelectLanguageActions; /** - * @brief Are we exiting the cppcheck? - * If this is true then the cppcheck is waiting for check threads to exit - * so that the application can be closed. - */ + * @brief Are we exiting the cppcheck? + * If this is true then the cppcheck is waiting for check threads to exit + * so that the application can be closed. + */ bool mExiting; - /** - * @brief Set to true in case of loading log file. - */ + /** @brief Set to true in case of loading log file. */ bool mIsLogfileLoaded; /**