diff ui/processhelp.h @ 1255:2a1aa9df8f11

(issue133) Improve API documentation
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 25 Sep 2014 17:58:12 +0200
parents 2a1206932f53
children 23df332b2a4c
line wrap: on
line diff
--- a/ui/processhelp.h	Thu Sep 25 17:37:03 2014 +0200
+++ b/ui/processhelp.h	Thu Sep 25 17:58:12 2014 +0200
@@ -15,12 +15,13 @@
 #include <QString>
 
 /**
- * @file processhelp.h 
+ * @file processhelp.h
  * @brief Static helper functions for process handling
  */
+/** @brief Static helper functions for process handling */
+class ProcessHelp {
 
-namespace ProcessHelp
-{
+public:
 /**
 * @brief look up process id's for a processName
 *
@@ -29,7 +30,7 @@
 * @param[in] processName the name of the process to look for
 * @returns a list of pids that match this process. May be empty
 */
-const QList<int> getProcessesIdForName(const QString &processName);
+static const QList<int> getProcessesIdForName(const QString &processName);
 
 /**
 * @brief check if another process with the same name exists
@@ -41,18 +42,18 @@
 *
 * @returns true if one or more processes (other than the current process) exist
 */
-bool otherProcessesExist(const QString &processName);
+static bool otherProcessesExist(const QString &processName);
 
 /**
 * @brief Activates the window for first found process
 * @param [in] executableName executableName (without path and .exe extension)
 */
-void activateWindowForProcess(const QString &executableName);
+static void activateWindowForProcess(const QString &executableName);
 
 /**
 * @brief Clean up internaly used infrastructure like pid/lock files.
 */
- void cleanUp(void);
-}
+static void cleanUp(void);
+};
 
 #endif // PROCESSHELP_H

http://wald.intevation.org/projects/trustbridge/