More source cleanups, added nice comments in methods_xxx files

scripting/methods/methods.cpp

@@ -39,3 +39,61 @@
 */
 
 
+
+/*
+
+-- Lua code to work out what functions are in what file:
+   
+
+require "commas"
+
+funcs = {}
+
+for _, v in ipairs (utils.functionlist ()) do
+  funcs [v] = true
+end -- for
+
+
+-- this function is called for every found file
+function load_file (name, stats)
+
+  print (string.rep ("-", 40))
+ 
+  local n = string.match (name, "[%w._]+$")
+  print (n)
+
+  print ""
+  print ("// Implements:")
+  print ""
+
+  local f = assert (io.open (name, "r"))  -- open it
+  local s = f:read ("*a")  -- read all of it
+  f:close ()  -- close it
+  
+  local t = {}
+
+  for w in string.gmatch (s, "CMUSHclientDoc::([%w_]+)") do
+    if funcs [w] then
+      table.insert (t, w)
+    end -- if a script function
+  end -- for
+
+  table.sort (t)
+
+  local done = {}
+
+  for _, name in ipairs (t) do
+     if not done [name] then
+       print ("//   ", name)
+     end -- if
+     done [name] = true
+  end -- for
+
+  print ""
+
+end -- load_file
+
+
+scan_dir ("\\source\\mushclient\\scripting\\methods", load_file)
+
+*/

scripting/methods/methods_accelerators.cpp

@@ -2,12 +2,6 @@
 
 #include "stdafx.h"
 #include "..\..\MUSHclient.h"
-
-//=============================================================
-// IMPORTANT - when adding methods here remember to add the 'glue'
-//             routine in lua_methods.cpp and add it to the library table
-//   - see comments at the end of methods.cpp
-//=============================================================
 #include "..\..\doc.h"
 #include "..\..\MUSHview.h"
 #include "..\..\mainfrm.h"
@@ -16,6 +10,11 @@
 #include "..\..\childfrm.h"
 #include "..\..\sendvw.h"
 
+// Implements:
+
+//    Accelerator
+//    AcceleratorList
+//    AcceleratorTo
 
 
 // accelerator finding functor

scripting/methods/methods_aliases.cpp

@@ -4,22 +4,28 @@
 
 #include "stdafx.h"
 #include "..\..\MUSHclient.h"
-
-//=============================================================
-// IMPORTANT - when adding methods here remember to add the 'glue'
-//             routine in lua_methods.cpp and add it to the library table
-//   - see comments at the end of methods.cpp
-//=============================================================
 #include "..\..\doc.h"
 #include "..\..\MUSHview.h"
 #include "..\..\mainfrm.h"
 #include "..\..\flags.h"
 #include "..\errors.h"
 
-// ******************************************************************************
-// **************************** ALIASES  ****************************************
-// ******************************************************************************
 
+// Implements:
+
+//    AddAlias
+//    DeleteAlias
+//    DeleteAliasGroup
+//    DeleteTemporaryAliases
+//    EnableAlias
+//    EnableAliasGroup
+//    GetAlias
+//    GetAliasInfo
+//    GetAliasList
+//    GetAliasOption
+//    GetAliasWildcard
+//    IsAlias
+//    SetAliasOption
 
 
 #define AO(arg) offsetof (CAlias, arg), sizeof (((CAlias *)NULL)->arg)

scripting/methods/methods_arrays.cpp

@@ -7,6 +7,29 @@
 #include "..\..\doc.h"
 #include "..\errors.h"
 
+
+// Implements:
+
+//    ArrayClear
+//    ArrayCount
+//    ArrayCreate
+//    ArrayDelete
+//    ArrayDeleteKey
+//    ArrayExists
+//    ArrayExport
+//    ArrayExportKeys
+//    ArrayGet
+//    ArrayGetFirstKey
+//    ArrayGetLastKey
+//    ArrayImport
+//    ArrayKeyExists
+//    ArrayListAll
+//    ArrayListKeys
+//    ArrayListValues
+//    ArraySet
+//    ArraySize
+
+
 /*
 
   arrays test: