Date: Wed, 16 Oct 2013 08:04:06 +0200 Subject: APIDump: Nicer HTML visage. * Fixed whacky HTML indentation + Added fancy CSS! + Now HTML5 compatible! --- MCServer/Plugins/APIDump/main.lua | 242 ++++++++++++++++++++++---------------- 1 file changed, 143 insertions(+), 99 deletions(-) (limited to 'MCServer/Plugins/APIDump/main.lua') diff --git a/MCServer/Plugins/APIDump/main.lua b/MCServer/Plugins/APIDump/main.lua index 163c505b2..22801b1e5 100644 --- a/MCServer/Plugins/APIDump/main.lua +++ b/MCServer/Plugins/APIDump/main.lua @@ -22,7 +22,7 @@ function Initialize(Plugin) Plugin:SetName("APIDump"); Plugin:SetVersion(1); - LOG("Initialized " .. Plugin:GetName() .. " v." .. Plugin:GetVersion()) + LOG("Initialised " .. Plugin:GetName() .. " v." .. Plugin:GetVersion()) g_PluginFolder = Plugin:GetLocalFolder(); @@ -212,48 +212,69 @@ function DumpAPIHtml() return; end - f:write([[MCServer API - index - -

MCServer API - index

The API reference is divided into the following sections:

Class index
Hooks
Extra pages

Class index

The following classes are available in the MCServer Lua scripting language: -

MCServer API - Index

The API reference is divided into the following sections:

+ +

Class index
Hooks
Extra pages

+ +

Class index

The following classes are available in the MCServer Lua scripting language:

+ +

" .. cls.Name .. "
" .. cls.Name .. "

Hooks

A plugin can register to be called whenever an “interesting event” occurs. It does so by calling - cPluginManager's AddHook() function and implementing a callback - function to handle the event.

A plugin can decide whether it will let the event pass through to the rest of the plugins, or hide it - from them. This is determined by the return value from the hook callback function. If the function returns - false or no value, the event is propagated further. If the function returns true, the processing is - stopped, no other plugin receives the notification (and possibly MCServer disables the default behavior - for the event). See each hook's details to see the exact behavior.

- - ]]); + f:write([[ + +

Hooks

+ +

A plugin can register to be called whenever an "interesting event" occurs. It does so by calling cPluginManager's AddHook() function and implementing a callback function to handle the event.

A plugin can decide whether it will let the event pass through to the rest of the plugins, or hide it from them. This is determined by the return value from the hook callback function. If the function returns false or no value, the event is propagated further. If the function returns true, the processing is stopped, no other plugin receives the notification (and possibly MCServer disables the default behavior for the event). See each hook's details to see the exact behavior.

+ +

Hook name	Called when

+ + + + +]]); for i, hook in ipairs(Hooks) do if (hook.DefaultFnName == nil) then -- The hook is not documented yet - f:write("\n"); + f:write(" \n \n \n \n"); table.insert(UndocumentedHooks, hook.Name); else - f:write("\n"); + f:write(" \n \n \n \n"); WriteHtmlHook(hook); end end - f:write([[

Hook name	Called when
" .. hook.Name .. "	(No documentation yet)
" .. hook.Name .. "	(No documentation yet)
" .. hook.Name .. "	" .. LinkifyString(hook.CalledWhen) .. "
" .. hook.Name .. "	" .. LinkifyString(hook.CalledWhen) .. "

Extra pages

The following pages provide various extra information

Extra pages

The following pages provide various extra information

" .. extra.Title .. "
" .. extra.Title .. "
" .. extra.Title .. " (file is missing)
" .. extra.Title .. " (file is missing)

Functions inherited from " .. a_InheritedName .. "

Name	Parameters	Return value	Notes

Name	Parameters	Return value	Notes
" .. func.Name .. "	" .. LinkifyString(func.Params or "").. "	" .. LinkifyString(func.Return or "").. "	" .. LinkifyString(func.Notes or "") .. "
" .. func.Name .. "	" .. LinkifyString(func.Params or "").. "	" .. LinkifyString(func.Return or "").. "	" .. LinkifyString(func.Notes or "") .. "

MCServer API - ]] .. a_ClassAPI.Name .. [[ class

MCServer API - ]] .. a_ClassAPI.Name .. [[

]] .. a_ClassAPI.Name .. [[

+ +

Inheritance
Inheritance
Constants
Functions
Constants
Functions
" .. additional.Header .. "
" .. additional.Header .. "

"); + cf:write("

" .. a_ClassAPI.Name .. " class

Class " .. a_ClassAPI.Name .. "

"); + cf:write("

"); cf:write(LinkifyString(a_ClassAPI.Desc)); - cf:write("

Inheritance

This class inherits from the following parent classes:

" .. cls.Name .. "
" .. cls.Name .. "

This class has the following descendants:\n"); + cf:write("

This class has the following descendants:\n"); WriteDescendants(a_ClassAPI.Descendants); - cf:write("

Constants

Name	Value	Notes

Name	Value	Notes
" .. cons.Name .. "	" .. cons.Value .. "	" .. LinkifyString(cons.Notes or "") .. "
" .. cons.Name .. "	" .. cons.Value .. "	" .. LinkifyString(cons.Notes or "") .. "

Functions

" .. additional.Header .. "

MCServer API - ]] .. a_Hook.DefaultFnName .. [[ hook

]] .. a_Hook.Name .. [[ hook

- ]]); + f:write([[ + + + MCServer API - Hook ]] .. a_Hook.DefaultFnName .. [[ + + + + + +

]] .. a_Hook.Name .. [[

+]]); f:write(LinkifyString(a_Hook.Desc)); - f:write("

Callback function

The default name for the callback function is "); - f:write(a_Hook.DefaultFnName .. ". It has the following signature:"); - f:write("

function " .. a_Hook.DefaultFnName .. "(");
+	f:write("			
\n			
Callback function
\n			The default name for the callback function is ");
+	f:write(a_Hook.DefaultFnName .. ". It has the following signature:\n\n");
+	f:write("			
function " .. a_Hook.DefaultFnName .. "(");
 	if (a_Hook.Params == nil) then
 		a_Hook.Params = {};
 	end
@@ -813,23 +853,27 @@ function WriteHtmlHook(a_Hook)
 		end
 		f:write(param.Name);
 	end
-	f:write(")
Parameters:\n\n");
+	f:write(")\n\n			
Parameters:
\n\n			Name Type Notes\n				\n					\n					\n					\n				\n");
 	for i, param in ipairs(a_Hook.Params) do
-		f:write("\n");
-	end
-	f:write("Name Type Notes
" .. param.Name .. " " .. LinkifyString(param.Type) .. " " .. LinkifyString(param.Notes) .. "
\n" .. (a_Hook.Returns or "") .. "\n");
-	f:write([[Code examples
-	Registering the callback
--cPluginManager.AddHook(cPluginManager.]] .. a_Hook.Name .. ", My" .. a_Hook.DefaultFnName .. [[);
-
-	]]);
+		f:write("				\n					" .. param.Name .. "\n					" .. LinkifyString(param.Type) .. "\n					" .. LinkifyString(param.Notes) .. "\n				\n");
+	end
+	f:write("			\n\n			" .. (a_Hook.Returns or "") .. "\n\n");
+	f:write([[			
Code examples
+			Registering the callback
+			
+]]);
+	f:write("			\n");
+	f:write([[cPluginManager.AddHook(cPluginManager.]] .. a_Hook.Name .. ", My" .. a_Hook.DefaultFnName .. [[);]]);
+	f:write("\n\n");
 	local Examples = a_Hook.CodeExamples or {};
 	for i, example in ipairs(Examples) do
-		f:write("" .. example.Title .. "\n");
-		f:write("" .. example.Desc .. "\n");
-		f:write("" .. example.Code .. "\n");
+		f:write("			" .. example.Title .. "\n");
+		f:write("			" .. example.Desc .. "\n\n");
+		f:write("			" .. example.Code .. "\n			\n\n");
 	end
+	f:write([[

MCServer API - index

Class index

MCServer API - Index

Class index

Hooks

Hooks

Extra pages

Extra pages

Functions inherited from " .. a_InheritedName .. "

Functions inherited from " .. a_InheritedName .. "

Contents

]] .. a_ClassAPI.Name .. [[

Contents

" .. a_ClassAPI.Name .. " class

Class " .. a_ClassAPI.Name .. "

Inheritance

Inheritance

Constants

Constants

Functions

Functions

" .. additional.Header .. "

" .. additional.Header .. "

]] .. a_Hook.Name .. [[ hook

]] .. a_Hook.Name .. [[

Callback function

Callback function

Parameters:

Code examples

Registering the callback

Code examples

Registering the callback

" .. example.Title .. "

" .. example.Title .. "