Updated articles.lua

Author: andrewmcwatters

scripts/docs/articles.lua

@@ -76,6 +76,9 @@ local function writeMethods( section, methods, separator )
 		-- Header
 		local md = {}
 		local signature = section .. separator .. method
+		if ( docs.isGameInterface( section ) ) then
+			signature = method
+		end
 		local constructor = section == method
 		if ( constructor ) then
 			signature = section
@@ -98,19 +101,21 @@ local function writeMethods( section, methods, separator )
 		insert( md, "" )
 
 		-- Usage
-		insert( md, r_header2( "Usage" ) )
 		require( "engine.shared.dblib" )
 		local params, isvararg = debug.getparameters( v[ method ] )
 		if ( params[ 1 ] == "self" ) then
 			table.remove( params, 1 )
 		end
-		local args = ( #params > 0 and "( " ..
-			concat( params, ", " ) .. ( isvararg and ", ..." or "" ) ..
-		" )" or "()" )
-		insert( md, "```lua\r\n" ..
-			signature .. args .. "\r\n" ..
-		"```" )
-		insert( md, "" )
+		if ( not docs.isGameInterface( section ) ) then
+			insert( md, r_header2( "Usage" ) )
+			local args = ( #params > 0 and "( " ..
+				concat( params, ", " ) .. ( isvararg and ", ..." or "" ) ..
+			" )" or "()" )
+			insert( md, "```lua\r\n" ..
+				signature .. args .. "\r\n" ..
+			"```" )
+			insert( md, "" )
+		end
 
 		-- Parameters
 		local parameters = {}
@@ -125,18 +130,22 @@ local function writeMethods( section, methods, separator )
 			insert( md, r_header2( "Parameters" ) )
 			insert( md, r_table( parameters ) )
 		end
-		insert( md, "" )
 
 		-- Stub
 		-- local baseHref = "https://github.com/Planimeter/grid-sdk/wiki/"
 		insert(
 			md,
-			"_This article is a stub. You can help Planimeter by expanding it._"
+			"*This article is a stub. You can help Planimeter by expanding it.*"
 		)
 		insert( md, "" )
 
+		local filename = section .. "." .. method
+		if ( docs.isGameInterface( section ) ) then
+			filename = method
+		end
+
 		md = concat( md, "\r\n" )
-		filesystem.write( "docs/" .. section .. "." .. method .. ".md", md )
+		filesystem.write( "docs/" .. filename .. ".md", md )
 	end
 end
 
@@ -176,6 +185,7 @@ local function writeArticles( section )
 end
 
 local sections = {}
+table.append( sections, { "game" } )
 table.append( sections, docs.getClasses() )
 table.append( sections, docs.getInterfacesAndLibraries() )
 table.append( sections, docs.getPanels() )

scripts/docs/init.lua

@@ -149,12 +149,6 @@ function getClasses()
 	return classes
 end
 
-function isClassMethod( f )
-	require( "engine.shared.dblib" )
-	local parameters = debug.getparameters( f )
-	return not parameters[ 1 ] or parameters[ 1 ] ~= "self"
-end
-
 function getClassMethods( class )
 	local classMethods = {}
 	local methods = getAllMethods( class )
@@ -173,10 +167,10 @@ function getInterfacesAndLibraries()
 		"serverengine",
 		"networkclient",
 		"networkserver",
-		"gameclient",
-		"gameserver",
+		-- "gameclient",
+		-- "gameserver",
 		"docs",
-		"game"
+		-- "game"
 	}
 	for k, v in pairs( _G ) do
 		if ( rawtype( v ) == "table" and
@@ -218,11 +212,6 @@ function getMethods( t )
 	return methods
 end
 
-function isPanel( modname )
-	local v = findModule( modname )
-	return typeof( v, "panel" ) or v == gui.panel
-end
-
 function getPanels()
 	local panels = {}
 	local blacklist = {
@@ -245,3 +234,24 @@ function getPanels()
 	table.sort( panels )
 	return panels
 end
+
+function isClassMethod( f )
+	require( "engine.shared.dblib" )
+	local parameters = debug.getparameters( f )
+	return not parameters[ 1 ] or parameters[ 1 ] ~= "self"
+end
+
+local interfaces = {
+	"gameclient",
+	"gameserver",
+	"game"
+}
+
+function isGameInterface( modname )
+	return table.hasvalue( interfaces, modname )
+end
+
+function isPanel( modname )
+	local v = findModule( modname )
+	return typeof( v, "panel" ) or v == gui.panel
+end

scripts/docs/sections.lua

@@ -96,6 +96,10 @@ local function r_methods( section, methods, separator )
 end
 
 local function writeSection( section )
+	if ( docs.isGameInterface( section ) ) then
+		return
+	end
+
 	local md = {}
 	insert( md, r_header( section ) )
 	insert( md, r_purpose( section ) )
@@ -107,7 +111,9 @@ local function writeSection( section )
 			insert( md, r_methods( section, docs.getClassMethods( v ), "." ) )
 		end
 
-		insert( md, r_constructor( section ) )
+		if ( v[ section ] ) then
+			insert( md, r_constructor( section ) )
+		end
 
 		if ( #docs.getMethods( v ) > 0 ) then
 			insert( md, r_header2( "Methods" ) )