Mercurial > trustbridge > trustbridge

comparison ui/processhelp.h @ 1255:2a1aa9df8f11

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(issue133) Improve API documentation
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 25 Sep 2014 17:58:12 +0200
parents 2a1206932f53
children 23df332b2a4c
comparison
equal deleted inserted replaced
1254:6d840341bc25 1255:2a1aa9df8f11
13 13
14 #include <QList> 14 #include <QList>
15 #include <QString> 15 #include <QString>
16 16
17 /** 17 /**
18 * @file processhelp.h 18 * @file processhelp.h
19 * @brief Static helper functions for process handling 19 * @brief Static helper functions for process handling
20 */ 20 */
21 /** @brief Static helper functions for process handling */
22 class ProcessHelp {
21 23
22 namespace ProcessHelp 24 public:
23 {
24 /** 25 /**
25 * @brief look up process id's for a processName 26 * @brief look up process id's for a processName
26 * 27 *
27 * Looks up processes run by the current user. 28 * Looks up processes run by the current user.
28 * 29 *
29 * @param[in] processName the name of the process to look for 30 * @param[in] processName the name of the process to look for
30 * @returns a list of pids that match this process. May be empty 31 * @returns a list of pids that match this process. May be empty
31 */ 32 */
32 const QList<int> getProcessesIdForName(const QString &processName); 33 static const QList<int> getProcessesIdForName(const QString &processName);
33 34
34 /** 35 /**
35 * @brief check if another process with the same name exists 36 * @brief check if another process with the same name exists
36 * 37 *
37 * Under GNU/Linux this only works for processes that have a 38 * Under GNU/Linux this only works for processes that have a
39 * 40 *
40 * @param[in] processName name of the process to look for. 41 * @param[in] processName name of the process to look for.
41 * 42 *
42 * @returns true if one or more processes (other than the current process) exist 43 * @returns true if one or more processes (other than the current process) exist
43 */ 44 */
44 bool otherProcessesExist(const QString &processName); 45 static bool otherProcessesExist(const QString &processName);
45 46
46 /** 47 /**
47 * @brief Activates the window for first found process 48 * @brief Activates the window for first found process
48 * @param [in] executableName executableName (without path and .exe extension) 49 * @param [in] executableName executableName (without path and .exe extension)
49 */ 50 */
50 void activateWindowForProcess(const QString &executableName); 51 static void activateWindowForProcess(const QString &executableName);
51 52
52 /** 53 /**
53 * @brief Clean up internaly used infrastructure like pid/lock files. 54 * @brief Clean up internaly used infrastructure like pid/lock files.
54 */ 55 */
55 void cleanUp(void); 56 static void cleanUp(void);
56 } 57 };
57 58
58 #endif // PROCESSHELP_H 59 #endif // PROCESSHELP_H
http://wald.intevation.org/projects/trustbridge/