GUI: Formatting comments

This commit is contained in:
Daniel Marjamäki 2016-10-02 18:23:51 +02:00
parent 0e78dd5eac
commit 143e7bf8b1
1 changed files with 161 additions and 309 deletions

View File

@ -72,16 +72,10 @@ public:
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();
/**
@ -90,22 +84,13 @@ public slots:
*/
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();
/**
@ -144,185 +129,101 @@ public slots:
*/
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);
/**
@ -344,9 +245,7 @@ private:
*/
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);
/**
@ -355,10 +254,7 @@ private:
*/
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);
/**
@ -373,7 +269,6 @@ private:
/**
* @brief Check project
*
* @param p imported project
*/
void DoCheckProject(ImportProject p);
@ -392,16 +287,10 @@ private:
*/
Settings GetCppcheckSettings();
/**
* @brief Load program settings
*
*/
/** @brief Load program settings */
void LoadSettings();
/**
* @brief Save program settings
*
*/
/** @brief Save program settings */
void SaveSettings() const;
/**
@ -410,9 +299,7 @@ private:
*/
void FormatAndSetTitle(const QString &text = QString());
/**
* @brief Show help contents
*/
/** @brief Show help contents */
void OpenOnlineHelp();
/**
@ -495,79 +382,46 @@ private:
*/
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;
/**
@ -577,9 +431,7 @@ private:
*/
bool mExiting;
/**
* @brief Set to true in case of loading log file.
*/
/** @brief Set to true in case of loading log file. */
bool mIsLogfileLoaded;
/**