Minor adjustments to the documentation of ZTree

src/Lib/ztree.cpp

@@ -27,7 +27,7 @@
 extern std::unique_ptr<lc::Settings> settings;
 
 /*!
- * Setup and start a new z-Tree instance with the given parameters
+ * \brief Setup and start a new z-Tree instance with the given parameters
  *
  * \param[in] argZTreeDataTargetPath The path where the new z-Tree instance
  * shall write its output to

src/Lib/ztree.h

@@ -27,7 +27,7 @@ class QProcess;
 namespace lc {
 
 /*!
- * A class to contain running z-Tree instances.
+ * \brief A class to contain running z-Tree instances.
  *
  * This class is element of every Session instance and is used to handle all
  * z-Tree related data as well as the execution of z-Tree itself.
@@ -41,6 +41,11 @@ public:
   ~ZTree() override;
 
 signals:
+  /*!
+   * \brief This is emitted if the represented z-Tree instance got closed
+   *
+   * \param argExitCode The exit code with which the z-Tree instance closed
+   */
   void ZTreeClosed(int argExitCode);
 
 private: