[tekui-devel] tekui: Element, RadioButton: removed getParent(); gendoc: trunca...

[Timm S. Mueller]

details:   http://hg.teklib.org/tekui/rev/2d279bc7c074
changeset: 379:2d279bc7c074
user:      Timm S. Mueller <tmueller at neoscientists.org>
date:      Sun Mar 23 21:31:13 2008 +0100
description:
Element, RadioButton: removed getParent(); gendoc: truncates classnames in
function link targets, added node for class overview, Markup specialization
now replaces dots with colons in links; Markup: recognizes dots as class
seperator in function links; improved documentation of Class, Area, Element,
Object, Frame

diffs (truncated from 468 to 100 lines):

diff -r 4f06631601c4 -r 2d279bc7c074 TODO
--- a/TODO	Sun Mar 23 18:23:52 2008 +0100
+++ b/TODO	Sun Mar 23 21:31:13 2008 +0100
@@ -15,6 +15,7 @@
 
 === General ===
 
+ * Splashscreen Window Mode
  * Alignment paramters: "left", "right", ...
  * Clearify terminology: Caption, Label, Heading, Title
  * FloatText styling options
diff -r 4f06631601c4 -r 2d279bc7c074 tek/app/gendoc.lua
--- a/tek/app/gendoc.lua	Sun Mar 23 18:23:52 2008 +0100
+++ b/tek/app/gendoc.lua	Sun Mar 23 21:31:13 2008 +0100
@@ -164,7 +164,7 @@ function processfile(state, fname)
 					else
 						title = ("%s(%s)%s"):format(docfunc, args, extra)
 					end
-
+					docfunc = docfunc:match("[^.:]+[.:]([^.:]+)") or docfunc
 					block = { }
 					parser = 2
 					addblock(("-"):rep(79) .. "\n\n")
@@ -173,7 +173,6 @@ function processfile(state, fname)
 					if doc and doc ~= "" then
 						addblock("%s\n", doc)
 					end
-
 					break
 				elseif line:match("^%-%-") then
 					parser = 1
@@ -484,7 +483,7 @@ function processtree(state)
 
 		state.classdiagram = { }
 		insert(state.classdiagram, ("-"):rep(79) .. "\n")
-		insert(state.classdiagram, "== Classes ==\n")
+		insert(state.classdiagram, "==( Class Overview )==\n")
 
 		for key, val in pairs(state.index) do
 			local t = { key = val }
@@ -569,6 +568,21 @@ function processtree(state)
 
 	state.textdoc = concat(state.documentation)
 
+end
+
+-------------------------------------------------------------------------------
+--	Markup specialization:
+-------------------------------------------------------------------------------
+
+local DocMarkup = Markup:newClass()
+
+function DocMarkup:link(link)
+	local funclink = link:match("^(.*%(%))$")
+	if funclink then
+		-- function links uniformly use colons; replace dots:
+		link = funclink:gsub("%.", ":")
+	end
+	return Markup.link(self, link)
 end
 
 -------------------------------------------------------------------------------
@@ -614,8 +628,8 @@ else
 		if state.plain then
 			print(state.textdoc)
 		else
-			Markup:new { input = state.textdoc, docname = args[4] }:run()
-		end
-	end
-
-end
+			DocMarkup:new { input = state.textdoc, docname = args[4] }:run()
+		end
+	end
+
+end
diff -r 4f06631601c4 -r 2d279bc7c074 tek/class.lua
--- a/tek/class.lua	Sun Mar 23 18:23:52 2008 +0100
+++ b/tek/class.lua	Sun Mar 23 21:31:13 2008 +0100
@@ -5,7 +5,15 @@
 --	See copyright notice in COPYRIGHT
 --
 --	OVERVIEW::
---	Class implements class inheritance and the creation of objects.
+--		[[#ClassOverview : Lineage]] :
+--		Class - implements inheritance and the creation of objects from classes
+--
+--	FUNCTIONS::
+--	- Class:checkDescend() - Checks if object descends from a class
+--	- Class:getClass() - Returns class of an object or superclass of a class
+--	- Class:getClassName() - Returns class name of an object or class
+--	- Class.new() - Creates and returns a new object
+--	- Class.newClass() - Creates a childclass from a superclass
 --
 -------------------------------------------------------------------------------
 
@@ -14,7 +22,7 @@ local setmetatable = setmetatable
 local setmetatable = setmetatable
 
 module "tek.class"