docs: Adding comments to the function API

Use doxygen style to write
This commit is contained in:
xmuli 2021-03-08 15:34:18 +08:00
parent 6c268362a7
commit f45a74c6e6
No known key found for this signature in database
GPG Key ID: 7980604EB89EB1DF
2 changed files with 23 additions and 0 deletions

View File

@ -1,6 +1,10 @@
#include "ifmetwindow.h" #include "ifmetwindow.h"
#include "ui_ifmetwindow.h" #include "ui_ifmetwindow.h"
/*!
* \brief IfmetWindow::IfmetWindow
* \param parent
*/
IfmetWindow::IfmetWindow(QWidget *parent) : IfmetWindow::IfmetWindow(QWidget *parent) :
QMainWindow(parent), QMainWindow(parent),
ui(new Ui::IfmetWindow) ui(new Ui::IfmetWindow)
@ -8,6 +12,9 @@ IfmetWindow::IfmetWindow(QWidget *parent) :
ui->setupUi(this); ui->setupUi(this);
} }
/*!
* \brief IfmetWindow::~IfmetWindow
*/
IfmetWindow::~IfmetWindow() IfmetWindow::~IfmetWindow()
{ {
delete ui; delete ui;

View File

@ -1,6 +1,22 @@
#include "ifmetwindow.h" #include "ifmetwindow.h"
#include <QApplication> #include <QApplication>
/*
* Copyright (C) 2021 All rights reserved.
*
* Author:
* github: https://github.com/xmuli
* blogs: https://ifmet.cn
*
* Qt Assistants 2021-03-08
*/
/*!
* \brief main
* \param argc
* \param argv
* \return
*/
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
QApplication a(argc, argv); QApplication a(argc, argv);