Updated articles.lua

Author: andrewmcwatters

scripts/docs/articles.lua

@@ -79,12 +79,26 @@ local function writeMethods( section, methods, separator )
 		local constructor = section == method
 		if ( constructor ) then
 			signature = section
+
+			if ( docs.isPanel( section ) ) then
+				signature = "gui." .. signature
+			end
 		end
 		insert( md, r_header( signature .. "()" ) )
 
+		-- Location
+		local v = docs.findModule( section )
+		insert( md, r_header2( "Source" ) )
+		local info = debug.getinfo( v[ method ], "S" )
+		local path = info.short_src
+		local line = info.linedefined
+		local href = "https://github.com/Planimeter/grid-sdk/blob/master/src/"
+		href = href .. path .. "#L" .. line
+		insert( md, "[`" .. path .. "`](" .. href .. ")" )
+		insert( md, "" )
+
 		-- Usage
 		insert( md, r_header2( "Usage" ) )
-		local v = docs.findModule( section )
 		require( "engine.shared.dblib" )
 		local params, isvararg = debug.getparameters( v[ method ] )
 		if ( params[ 1 ] == "self" ) then
@@ -111,8 +125,16 @@ 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._"
+		)
 		insert( md, "" )
+
 		md = concat( md, "\r\n" )
 		filesystem.write( "docs/" .. section .. "." .. method .. ".md", md )
 	end

scripts/docs/init.lua

@@ -17,6 +17,7 @@ local string     = string
 local table      = table
 local tostring   = tostring
 local type       = type
+local typeof     = typeof
 local _G         = _G
 
 module( "docs" )
@@ -217,6 +218,11 @@ 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 = {

scripts/docs/sections.lua

@@ -71,20 +71,13 @@ local function r_header2( header )
 	return concat( md, "\r\n" )
 end
 
-local function isPanel( module )
-	local v = docs.findModule( module )
-	return typeof( v, "panel" ) or v == gui.panel
-end
-
 local function r_constructor( section )
 	local md = {}
 	insert( md, r_header2( "Constructor" ) )
-	local modname = isPanel( section ) and "gui" or section
-	insert(
-		md,
-		"* [`" .. ( modname == "gui" and "gui." or "" ) .. section .. "()`]" ..
-		"(" .. modname .. "." .. section .. ")"
-	)
+	local modname = docs.isPanel( section ) and "gui" or section
+	local signature = ( modname == "gui" and "gui." or "" ) .. section
+	local href = ( modname == "gui" and section or modname ) .. "." .. section
+	insert(	md, "* [`" .. signature .. "()`]" .. "(" .. href .. ")" )
 	insert( md, "" )
 	return concat( md, "\r\n" )
 end