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
2 changed files with 23 additions and 0 deletions

View File

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

View File

@@ -1,6 +1,22 @@
#include "ifmetwindow.h"
#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[])
{
QApplication a(argc, argv);