From df2a4e9074d22deb2477dd94dd8fe86cda555a16 Mon Sep 17 00:00:00 2001 From: markuspg Date: Tue, 15 Sep 2020 14:36:06 +0200 Subject: [PATCH] Minor adjustments to the documentation of ZTree --- src/Lib/ztree.cpp | 2 +- src/Lib/ztree.h | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/src/Lib/ztree.cpp b/src/Lib/ztree.cpp index c95ac5f..c00c0f4 100644 --- a/src/Lib/ztree.cpp +++ b/src/Lib/ztree.cpp @@ -27,7 +27,7 @@ extern std::unique_ptr 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 diff --git a/src/Lib/ztree.h b/src/Lib/ztree.h index 02d4cf8..68b9fe8 100644 --- a/src/Lib/ztree.h +++ b/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: