plugins: use new header

1 files changed, 10 insertions, 2 deletions

diff --git a/plugins/mumble_plugin_main.h b/plugins/mumble_plugin_main.h
index 26539a6a6..dc770b55a 100644
--- a/plugins/mumble_plugin_main.h
+++ b/plugins/mumble_plugin_main.h
@@ -1,15 +1,23 @@
-// Copyright 2005-2019 The Mumble Developers. All rights reserved.
+// Copyright 2019 The Mumble Developers. All rights reserved.
 // Use of this source code is governed by a BSD-style license
 // that can be found in the LICENSE file at the root of the
 // Mumble source tree or at <https://www.mumble.info/LICENSE>.
 
+// This is the main header for process/OS stuff; it's included in most plugins
+// because values can rarely be retrieved without accessing the process' memory.
+//
+// Various functions are provided for common tasks when reading from memory.
+// The most important are getModuleAddr() and peekProc(); the first returns the
+// base address of a module (e.g. shared library), the latter reads memory at the
+// specified address and stores it in a variable.
+
 #ifndef MUMBLE_PLUGIN_MAIN_H_
 #define MUMBLE_PLUGIN_MAIN_H_
 
 #include "mumble_plugin.h"
 
-static procid_t pPid;
 static bool is64Bit;
+static procid_t pPid;
 static procptr_t pModule;
 
 static inline bool peekProc(const procptr_t &addr, void *dest, const size_t &len);