Докуметирование кода

src/myx-cmake-example-features/main.cpp

@@ -1,3 +1,7 @@
+/**
+ * \file Основной файл проекта
+ */
+
 #include "processor.hpp"
 
 #include <QCoreApplication>
@@ -5,18 +9,32 @@
 #include <QFile>
 #include <QTimer>
 
+/**
+ * @brief Перевод строки в целое число
+ * @param Строка
+ * @return Целое число
+ */
 int qStringToInt( const QString s )
 {
 	return( s.toInt() );
 }
 
 
+/**
+ * \brief Неиспользуемая функция для тестирования анализа покрытия кода
+ */
 int unused( int a )
 {
 	return( a );
 }
 
 
+/**
+ * \brief Основная функция
+ * \param argc Количество параметров командной строки
+ * \param argv Массив параметров
+ * \return Результат выполнения QApplication::exec()
+ */
 int main( int argc, char** argv )
 {
 	QCoreApplication app( argc, argv );

src/myx-cmake-example-features/processor.hpp

@@ -1,3 +1,7 @@
+/**
+ * \file Класс Processor
+ */
+
 #ifndef PROCESSOR_HPP_
 #define PROCESSOR_HPP_
 
@@ -6,11 +10,17 @@
 #include <QObject>
 #include <QDebug>
 
+/**
+ * \brief Класс Processor
+ */
 class Processor : public QObject
 {
 	Q_OBJECT
 public:
+	/**
+	 * \brief Слот, печатающий сообщение
+	 */
 	Q_SLOT void process() { qCritical() << "about to close"; }
 };
 
-#endif
+#endif // ifndef PROCESSOR_HPP_