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

APIDump: Functions that are documented are never ignored.

Browse Source 
This simplifies exclude-filters for functions such as lxp.new() that need inclusion.
This commit is contained in:
madmaxoft 2013-11-15 22:39:02 +01:00
parent 2ed8e38419
commit 905cd0e73e
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -373,13 +373,18 @@ function ReadDescriptions(a_API)
return false; return false;
end end
-- Returns true if the function (specified by its fully qualified name) is to be ignored -- Returns true if the function is to be ignored
local function IsFunctionIgnored(a_FnName) local function IsFunctionIgnored(a_ClassName, a_FnName)
if (g_APIDesc.IgnoreFunctions == nil) then if (g_APIDesc.IgnoreFunctions == nil) then
return false; return false;
end end
if (((g_APIDesc.Classes[a_ClassName] or {}).Functions or {})[a_FnName] ~= nil) then
-- The function is documented, don't ignore
return false;
end
local FnName = a_ClassName .. "." .. a_FnName;
for i, name in ipairs(g_APIDesc.IgnoreFunctions) do for i, name in ipairs(g_APIDesc.IgnoreFunctions) do
if (a_FnName:match(name)) then if (FnName:match(name)) then
return true; return true;
end end
end end
@ -482,7 +487,7 @@ function ReadDescriptions(a_API)
if (FnDesc == nil) then if (FnDesc == nil) then
-- No description for this API function -- No description for this API function
AddFunction(func.Name); AddFunction(func.Name);
if not(IsFunctionIgnored(cls.Name .. "." .. FnName)) then if not(IsFunctionIgnored(cls.Name, FnName)) then
table.insert(cls.UndocumentedFunctions, FnName); table.insert(cls.UndocumentedFunctions, FnName);
end end
else else
@ -505,7 +510,7 @@ function ReadDescriptions(a_API)
else -- if (APIDesc.Functions ~= nil) else -- if (APIDesc.Functions ~= nil)
for j, func in ipairs(cls.Functions) do for j, func in ipairs(cls.Functions) do
local FnName = func.DocID or func.Name; local FnName = func.DocID or func.Name;
if not(IsFunctionIgnored(cls.Name .. "." .. FnName)) then if not(IsFunctionIgnored(cls.Name, FnName)) then
table.insert(cls.UndocumentedFunctions, FnName); table.insert(cls.UndocumentedFunctions, FnName);
end end
end end
@ -567,7 +572,7 @@ function ReadDescriptions(a_API)
g_Stats.NumUndocumentedClasses = g_Stats.NumUndocumentedClasses + 1; g_Stats.NumUndocumentedClasses = g_Stats.NumUndocumentedClasses + 1;
for j, func in ipairs(cls.Functions) do for j, func in ipairs(cls.Functions) do
local FnName = func.DocID or func.Name; local FnName = func.DocID or func.Name;
if not(IsFunctionIgnored(cls.Name .. "." .. FnName)) then if not(IsFunctionIgnored(cls.Name, FnName)) then
table.insert(cls.UndocumentedFunctions, FnName); table.insert(cls.UndocumentedFunctions, FnName);
end end
end -- for j, func - cls.Functions[] end -- for j, func - cls.Functions[]
@ -586,7 +591,7 @@ function ReadDescriptions(a_API)
-- Remove ignored functions: -- Remove ignored functions:
local NewFunctions = {}; local NewFunctions = {};
for j, fn in ipairs(cls.Functions) do for j, fn in ipairs(cls.Functions) do
if (not(IsFunctionIgnored(cls.Name .. "." .. fn.Name))) then if (not(IsFunctionIgnored(cls.Name, fn.Name))) then
table.insert(NewFunctions, fn); table.insert(NewFunctions, fn);
end end
end -- for j, fn end -- for j, fn