add some explanatory text to the top of the header

2020-08-11 19:47:04 -07:00 · 2020-08-11 19:47:04 -07:00 · bda678bcd4
parent 39ae2d95fc
commit bda678bcd4
1 changed files with 8 additions and 0 deletions
--- a/library/include/PluginStatics.h
+++ b/library/include/PluginStatics.h
@ -1,3 +1,11 @@
+/*
+ * This file and the companion PluginStatics.cpp contain static structures used
+ * by DFHack plugins. Linking them here, into the dfhack library, instead of
+ * into the plugins themselves allows the plugins to be freely unloaded and
+ * reloaded without fear of causing cached references to static data becoming
+ * corrupted.
+ */
+
 #pragma once

 #include "DataIdentity.h"