lime-system: added inline documentation for hardware_detection module

libremesh · Jul 8, 2014 · d3fa39f · d3fa39f
1 parent 1b7206a
commit d3fa39f
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/lime-system/files/usr/lib/lua/lime/hardware_detection.lua b/packages/lime-system/files/usr/lib/lua/lime/hardware_detection.lua
@@ -6,6 +6,8 @@ local utils = require("lime.utils")
 
 hardware_detection = {}
 
+--! Hardware detection module clean()
+--! Call clean() from all installed submodules
 function hardware_detection.clean()
 	for hwd_module_path in fs.glob("/usr/lib/lua/lime/hwd/*.lua") do
 		local module_name = "lime.hwd." .. fs.basename(hwd_module_path):sub(1,-5)
@@ -15,6 +17,8 @@ function hardware_detection.clean()
 	end
 end
 
+--! Hardware detection module configure()
+--! Call detect_hardware() from all installed submodules
 function hardware_detection.configure()
 	for hwd_module_path in fs.glob("/usr/lib/lua/lime/hwd/*.lua") do
 		local module_name = "lime.hwd." .. fs.basename(hwd_module_path):sub(1,-5)