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

APIDump: Undescribed classes are listed as undocumented.

Browse Source 
Previously class that was not listed in APIDesc was not listed in Undocumented.
This commit is contained in:
madmaxoft 2013-09-14 23:47:37 +02:00
parent 7ec598d8d4
commit b8a37c4f46
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -222,7 +222,6 @@ function DumpAPIHtml()
f:write("\n-- This is the list of undocumented API objects, automatically generated by APIDump\n\n"); f:write("\n-- This is the list of undocumented API objects, automatically generated by APIDump\n\n");
f:write("g_APIDesc =\n{\n\tClasses =\n\t{\n"); f:write("g_APIDesc =\n{\n\tClasses =\n\t{\n");
for i, cls in ipairs(API) do for i, cls in ipairs(API) do
local HasWrittenClassHeader = false;
local HasFunctions = ((cls.UndocumentedFunctions ~= nil) and (#cls.UndocumentedFunctions > 0)); local HasFunctions = ((cls.UndocumentedFunctions ~= nil) and (#cls.UndocumentedFunctions > 0));
local HasConstants = ((cls.UndocumentedConstants ~= nil) and (#cls.UndocumentedConstants > 0)); local HasConstants = ((cls.UndocumentedConstants ~= nil) and (#cls.UndocumentedConstants > 0));
if (HasFunctions or HasConstants) then if (HasFunctions or HasConstants) then
@ -318,8 +317,6 @@ function ReadDescriptions(a_API)
return false; return false;
end end
local UnexportedDocumented = {}; -- List of API objects that are documented but not exported, simply a list of names
for i, cls in ipairs(a_API) do for i, cls in ipairs(a_API) do
-- Rename special functions: -- Rename special functions:
for j, fn in ipairs(cls.Functions) do for j, fn in ipairs(cls.Functions) do
@ -394,11 +391,6 @@ 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;
-- Add all non-exported function descriptions to UnexportedDocumented:
for j, func in pairs(APIDesc.Functions) do
-- TODO
end
end -- if (APIDesc.Functions ~= nil) end -- if (APIDesc.Functions ~= nil)
if (APIDesc.Constants ~= nil) then if (APIDesc.Constants ~= nil) then
@ -415,13 +407,23 @@ function ReadDescriptions(a_API)
CnDesc.IsExported = true; CnDesc.IsExported = true;
end end
end -- for j, cons end -- for j, cons
-- Add all non-exported constant descriptions to UnexportedDocumented:
for j, cons in pairs(APIDesc.Constants) do
-- TODO
end
end -- if (APIDesc.Constants ~= nil) end -- if (APIDesc.Constants ~= nil)
end -- if (APIDesc ~= nil) else
-- Class is not documented at all, add all its members to Undocumented lists:
cls.UndocumentedFunctions = {};
cls.UndocumentedConstants = {};
for j, func in ipairs(cls.Functions) do
local FnName = func.DocID or func.Name;
if not(IsFunctionIgnored(cls.Name .. "." .. FnName)) then
table.insert(cls.UndocumentedFunctions, FnName);
end
end -- for j, func - cls.Functions[]
for j, cons in ipairs(cls.Constants) do
if not(IsConstantIgnored(cls.Name .. "." .. cons.Name)) then
table.insert(cls.UndocumentedConstants, cons.Name);
end
end -- for j, cons - cls.Constants[]
end -- else if (APIDesc ~= nil)
-- Remove ignored functions: -- Remove ignored functions:
local NewFunctions = {}; local NewFunctions = {};