summaryrefslogtreecommitdiffstats
path: root/Server/Plugins/APIDump/main_APIDump.lua
diff options
context:
space:
mode:
authorMattes D <github@xoft.cz>2016-07-06 16:11:15 +0200
committerMattes D <github@xoft.cz>2016-07-18 22:11:41 +0200
commit0e24a0beaef55a4753ce4db9d3f5f9a3872bd026 (patch)
tree20fd1ec85ad30658c6314bf83bc52872adfba6ae /Server/Plugins/APIDump/main_APIDump.lua
parentUpdated API documentation. (diff)
downloadcuberite-0e24a0beaef55a4753ce4db9d3f5f9a3872bd026.tar
cuberite-0e24a0beaef55a4753ce4db9d3f5f9a3872bd026.tar.gz
cuberite-0e24a0beaef55a4753ce4db9d3f5f9a3872bd026.tar.bz2
cuberite-0e24a0beaef55a4753ce4db9d3f5f9a3872bd026.tar.lz
cuberite-0e24a0beaef55a4753ce4db9d3f5f9a3872bd026.tar.xz
cuberite-0e24a0beaef55a4753ce4db9d3f5f9a3872bd026.tar.zst
cuberite-0e24a0beaef55a4753ce4db9d3f5f9a3872bd026.zip
Diffstat (limited to 'Server/Plugins/APIDump/main_APIDump.lua')
-rw-r--r--Server/Plugins/APIDump/main_APIDump.lua14
1 files changed, 9 insertions, 5 deletions
diff --git a/Server/Plugins/APIDump/main_APIDump.lua b/Server/Plugins/APIDump/main_APIDump.lua
index 1129a24ec..429a563df 100644
--- a/Server/Plugins/APIDump/main_APIDump.lua
+++ b/Server/Plugins/APIDump/main_APIDump.lua
@@ -504,8 +504,8 @@ local function ReadDescriptions(a_API, a_Desc)
local DoxyFunctions = {}; -- This will contain all the API functions together with their documentation
- local function AddFunction(a_Name, a_Params, a_Return, a_Notes)
- table.insert(DoxyFunctions, {Name = a_Name, Params = a_Params, Return = a_Return, Notes = a_Notes});
+ local function AddFunction(a_Name, a_Params, a_Return, a_IsStatic, a_Notes)
+ table.insert(DoxyFunctions, {Name = a_Name, Params = a_Params, Return = a_Return, IsStatic = a_IsStatic, Notes = a_Notes});
end
if (APIDesc.Functions ~= nil) then
@@ -523,11 +523,11 @@ local function ReadDescriptions(a_API, a_Desc)
-- Description is available
if (FnDesc[1] == nil) then
-- Single function definition
- AddFunction(func.Name, FnDesc.Params, FnDesc.Return, FnDesc.Notes);
+ AddFunction(func.Name, FnDesc.Params, FnDesc.Return, FnDesc.IsStatic, FnDesc.Notes);
else
-- Multiple function overloads
for _, desc in ipairs(FnDesc) do
- AddFunction(func.Name, desc.Params, desc.Return, desc.Notes);
+ AddFunction(func.Name, desc.Params, desc.Return, desc.IsStatic, desc.Notes);
end -- for k, desc - FnDesc[]
end
FnDesc.IsExported = true;
@@ -778,10 +778,14 @@ local function WriteHtmlClass(a_ClassAPI, a_ClassMenu)
end
cf:write("<table>\n<tr><th>Name</th><th>Parameters</th><th>Return value</th><th>Notes</th></tr>\n");
for _, func in ipairs(a_Functions) do
+ local StaticClause = ""
+ if (func.IsStatic) then
+ StaticClause = "(STATIC) "
+ end
cf:write("<tr><td>", func.Name, "</td>\n");
cf:write("<td>", LinkifyString(func.Params or "", (a_InheritedName or a_ClassAPI.Name)), "</td>\n");
cf:write("<td>", LinkifyString(func.Return or "", (a_InheritedName or a_ClassAPI.Name)), "</td>\n");
- cf:write("<td>", LinkifyString(func.Notes or "<i>(undocumented)</i>", (a_InheritedName or a_ClassAPI.Name)), "</td></tr>\n");
+ cf:write("<td>", StaticClause .. LinkifyString(func.Notes or "<i>(undocumented)</i>", (a_InheritedName or a_ClassAPI.Name)), "</td></tr>\n");
end
cf:write("</table>\n");
end