explain createModule()'s optional SGPropertyNode argument

diff --git a/src/Scripting/NasalSys.cxx b/src/Scripting/NasalSys.cxx
index 7ae4244647223dc679060b61f034747f5cff2ba6..5343c06faa04896377943ff690782715e2914051 100644 (file)
--- a/src/Scripting/NasalSys.cxx
+++ b/src/Scripting/NasalSys.cxx
@@ -481,7 +481,9 @@ void FGNasalSys::loadModule(SGPath file, const char* module)
 }
 
 // Parse and run.  Save the local variables namespace, as it will
-// become a sub-object of globals.
+// become a sub-object of globals.  The optional "arg" argument can be
+// used to pass an associated property node to the module, which can then
+// be accessed via cmdarg().  (This is, for example, used by XML dialogs.)
 void FGNasalSys::createModule(const char* moduleName, const char* fileName,
                               const char* src, int len, const SGPropertyNode* arg)
 {