flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDump: Fixed listing undocumented objects.

Browse Source 
Classes with undefined "Functions" section would not list their functions as undocumented; similar for "Constants" and "Variables".
This commit is contained in:
madmaxoft 2013-10-20 10:33:40 +02:00
parent 34928378b8
commit 4f40eb7f55
1 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
MCServer/Plugins/APIDump/main.lua
View File

@ -89,7 +89,9 @@ function CreateAPITables()
{Name = "IsInside"} {Name = "IsInside"}
}, },
Constants = { Constants = {
} },
Variables = {
},
Descendants = {}, -- Will be filled by ReadDescriptions(), array of class APIs (references to other member in the tree) Descendants = {}, -- Will be filled by ReadDescriptions(), array of class APIs (references to other member in the tree)
}}, }},
{ {
@ -98,12 +100,14 @@ function CreateAPITables()
{Name = "Clear"}, {Name = "Clear"},
{Name = "CopyFrom"}, {Name = "CopyFrom"},
... ...
} },
Constants = { Constants = {
{Name = "baTypes", Value = 0}, {Name = "baTypes", Value = 0},
{Name = "baMetas", Value = 1}, {Name = "baMetas", Value = 1},
... ...
} },
Variables = {
},
... ...
}} }}
}; };
@ -464,6 +468,12 @@ function ReadDescriptions(a_API)
-- Replace functions with their described and overload-expanded versions: -- Replace functions with their described and overload-expanded versions:
cls.Functions = DoxyFunctions; cls.Functions = DoxyFunctions;
else -- if (APIDesc.Functions ~= nil)
for j, func in ipairs(cls.Functions) do
if not(IsFunctionIgnored(cls.Name .. "." .. FnName)) then
table.insert(cls.UndocumentedFunctions, FnName);
end
end
end -- if (APIDesc.Functions ~= nil) end -- if (APIDesc.Functions ~= nil)
if (APIDesc.Constants ~= nil) then if (APIDesc.Constants ~= nil) then
@ -480,7 +490,13 @@ function ReadDescriptions(a_API)
CnDesc.IsExported = true; CnDesc.IsExported = true;
end end
end -- for j, cons end -- for j, cons
end -- if (APIDesc.Constants ~= nil) else -- if (APIDesc.Constants ~= nil)
for j, cons in ipairs(cls.Constants) do
if not(IsConstantIgnored(cls.Name .. "." .. cons.Name)) then
table.insert(cls.UndocumentedConstants, cons.Name);
end
end
end -- else if (APIDesc.Constants ~= nil)
-- Assign member variables' descriptions: -- Assign member variables' descriptions:
if (APIDesc.Variables ~= nil) then if (APIDesc.Variables ~= nil) then
@ -498,7 +514,13 @@ function ReadDescriptions(a_API)
end end
end end
end -- for j, var end -- for j, var
end -- if (APIDesc.Variables ~= nil) else -- if (APIDesc.Variables ~= nil)
for j, var in ipairs(cls.Variables) do
if not(IsVariableIgnored(cls.Name .. "." .. var.Name)) then
table.insert(cls.UndocumentedVariables, var.Name);
end
end
end -- else if (APIDesc.Variables ~= nil)
else -- if (APIDesc ~= nil) else -- if (APIDesc ~= nil)