From 333bdb204c7ff7c5f0e37d6ad5ca63d62fbdaf2a Mon Sep 17 00:00:00 2001
From: barthgr <barthgr@mi.fu-berlin.de>
Date: Thu, 1 Nov 2018 13:45:14 +0100
Subject: [PATCH] update code documentation
---
SrcBehaviorLoader/PluginLoader.cpp | 12 ++++++------
SrcBehaviorLoader/PluginLoader.h | 13 ++++++++++---
2 files changed, 16 insertions(+), 9 deletions(-)
diff --git a/SrcBehaviorLoader/PluginLoader.cpp b/SrcBehaviorLoader/PluginLoader.cpp
index a7754e8..5adabb6 100644
--- a/SrcBehaviorLoader/PluginLoader.cpp
+++ b/SrcBehaviorLoader/PluginLoader.cpp
@@ -13,9 +13,9 @@
#include <QFileInfo>
#define MAX_KEY_LENGTH 255
#define MAX_VALUE_NAME 16383
-
+
std::vector<std::string> QueryKey(HKEY hKey, std::string path)
-{
+{
//See https://docs.microsoft.com/en-us/windows/desktop/sysinfo/enumerating-registry-subkeys
std::vector<std::string> list;
TCHAR achClass[MAX_PATH] = TEXT(""); // buffer for class name
@@ -28,12 +28,12 @@ std::vector<std::string> QueryKey(HKEY hKey, std::string path)
DWORD cbMaxValueData; // longest value data
DWORD cbSecurityDescriptor; // size of security descriptor
FILETIME ftLastWriteTime; // last write time
-
- DWORD i, retCode;
-
+
+ DWORD i, retCode;
+
TCHAR achValue[MAX_VALUE_NAME];
DWORD cchValue = MAX_VALUE_NAME;
-
+
// Get the class name and the value count.
retCode = RegQueryInfoKey(
hKey, // key handle
diff --git a/SrcBehaviorLoader/PluginLoader.h b/SrcBehaviorLoader/PluginLoader.h
index 5fb18fa..221a8b6 100644
--- a/SrcBehaviorLoader/PluginLoader.h
+++ b/SrcBehaviorLoader/PluginLoader.h
@@ -8,8 +8,14 @@
#include <map>
#include <memory>
+/**
+ * \class PluginLoader
+ * This class loads Qt-Plugins, the related metadata and files the plugin depends on.
+ * \author Hauke Mönck, Gregor Barth
+ */
+
class PluginLoader : QObject
-{
+{
Q_OBJECT
public:
explicit PluginLoader(QObject *parent = 0);
@@ -29,7 +35,8 @@ public:
QStringListModel* getPluginList();
/**
- * Loads a BioTracker Plugin from a filpaht. It returns true if the Plugin could be loaded, otherwise false.
+ * Loads a BioTracker Plugin from a file path. It returns true if the Plugin could be loaded, otherwise false.
+ * The loaded plugin acts as singleton!
*/
bool loadPluginFromFilename(QString const& filename);
@@ -95,4 +102,4 @@ private:
QStringListModel* m_PluginListModel;
};
-#endif // PLUGINLOADER_H
\ No newline at end of file
+#endif // PLUGINLOADER_H
--
GitLab