Skip to content

Commit 7df3670

Browse files
author
Daniel Marjamäki
committed
doc: updated doxygen comments. three groups where created - 'GUI', 'Core' and 'Checks'
1 parent 968a6bd commit 7df3670

36 files changed

Lines changed: 265 additions & 72 deletions

‎gui/aboutdialog.h‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424

2525
#include "ui_about.h"
2626

27+
/// @addtogroup GUI
28+
/// @{
2729

2830
/**
2931
* @brief About dialog
@@ -38,5 +40,5 @@ class AboutDialog : public QDialog
3840
private:
3941
Ui::About mUI;
4042
};
41-
43+
/// @}
4244
#endif // ABOUT_DIALOG_H

‎gui/applicationdialog.h‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
#include <QLineEdit>
2424
#include "ui_application.h"
2525

26+
/// @addtogroup GUI
27+
/// @{
28+
2629
/**
2730
* @brief Dialog to edit a startable application.
2831
* User can open errors with user specified applications. This is a dialog
@@ -79,5 +82,5 @@ protected slots:
7982
Ui::ApplicationDialog mUI;
8083
private:
8184
};
82-
85+
/// @}
8386
#endif // APPLICATIONDIALOG_H

‎gui/applicationlist.h‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222
#include <QObject>
2323
#include <QSettings>
2424

25+
/// @addtogroup GUI
26+
/// @{
27+
2528

2629
/**
2730
* @brief List of applications user has specified to open errors with
@@ -159,5 +162,5 @@ class ApplicationList : public QObject
159162
QList<ApplicationType> mApplications;
160163
private:
161164
};
162-
165+
/// @}
163166
#endif // APPLICATIONLIST_H

‎gui/checkthread.h‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
#include "../src/settings.h"
2626
#include "threadresult.h"
2727

28+
/// @addtogroup GUI
29+
/// @{
30+
2831
/**
2932
* @brief Thread to run cppcheck
3033
*
@@ -91,5 +94,5 @@ class CheckThread : public QThread
9194
CppCheck mCppcheck;
9295
private:
9396
};
94-
97+
/// @}
9598
#endif // CHECKTHREAD_H

‎gui/common.h‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@
1919
#ifndef COMMON_H
2020
#define COMMON_H
2121

22+
/// @addtogroup GUI
23+
/// @{
24+
25+
2226
/**
2327
* @brief List of error types to show
2428
*
@@ -56,5 +60,5 @@ ShowTypes;
5660
#define SETTINGS_LANGUAGE "Application language"
5761
#define SETTINGS_TOOLBARS_SHOW "Toolbars/ShowStandard"
5862

59-
63+
/// @}
6064
#endif

‎gui/csvreport.h‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@
2626
#include <QTextStream>
2727
#include "report.h"
2828

29+
/// @addtogroup GUI
30+
/// @{
31+
32+
2933
/**
3034
* @brief CSV text file report.
3135
* This report exports results as CSV (comma separated values). CSV files are
@@ -68,5 +72,5 @@ class CsvReport : public Report
6872
*/
6973
QTextStream mTxtWriter;
7074
};
71-
75+
/// @}
7276
#endif // CSV_REPORT_H

‎gui/fileviewdialog.h‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
#include <QString>
2424
#include "ui_file.h"
2525

26+
/// @addtogroup GUI
27+
/// @{
28+
2629

2730
/**
2831
* @brief File view -dialog.
@@ -58,5 +61,5 @@ class FileViewDialog : public QDialog
5861

5962
Ui::Fileview mUI;
6063
};
61-
64+
/// @}
6265
#endif // FILEVIEW_DIALOG_H

‎gui/mainwindow.h‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@
3434
#include "ui_main.h"
3535
class ThreadHandler;
3636

37+
38+
/// @addtogroup GUI
39+
/// @{
40+
41+
3742
/**
3843
* @brief Main window for cppcheck-gui
3944
*
@@ -308,5 +313,5 @@ protected slots:
308313
QString mCurrentDirectory;
309314

310315
};
311-
316+
/// @}
312317
#endif // MAINWINDOW_H

‎gui/projectfile.h‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
#include <QStringList>
2525
#include <QXmlStreamReader>
2626

27+
/// @addtogroup GUI
28+
/// @{
29+
30+
2731
/**
2832
* @brief A class that reads and writes (TODO) project files.
2933
* The project files contain project-specific settings for checking. For
@@ -85,5 +89,5 @@ class ProjectFile : public QObject
8589
*/
8690
QStringList mIncludeDirs;
8791
};
88-
92+
/// @}
8993
#endif // PROJECT_FILE_H

‎gui/report.h‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424
#include <QStringList>
2525
#include <QFile>
2626

27+
/// @addtogroup GUI
28+
/// @{
29+
2730
/**
2831
* @brief A base class for reports.
2932
*/
@@ -88,5 +91,5 @@ class Report : public QObject
8891
*/
8992
QFile mFile;
9093
};
91-
94+
/// @}
9295
#endif // REPORT_H

0 commit comments

Comments
 (0)