mirror of
https://github.com/brues-code/ClassicAPI.git
synced 2026-11-16 16:10:36 +00:00
docs/API.md is 18.7k lines and its anchors are signature slugs, so editing a signature breaks the 281 internal and 88 README links into it. Blizzard solved the same problem by shipping the API as data plus a browser addon, and warcraft.wiki.gg renders those same tables. One set of descriptors can feed all three. Each registration now carries one next to it: typed arguments and returns, nilability, defaults, and a sentence. Events, enumerations and returned table shapes are described the same way. No Script_* body changed. Game.h gains namespace Game::Doc (Field with Req/Opt/Vararg, FieldList, Function, Method, Structure, Event) and a trailing descriptor argument on all six Game::Lua::Register* plus Event::Custom::AutoReserve. api/Documentation.cpp records every registration on the first pass of each Lua state and seals it, so /reload re-registers but records nothing and the environment comes from which pass saw the name. Export is lazy: nothing is materialized until C_APIDocumentation.GetSystem asks for one system, because eager export would build thousands of tables per reload for a slash command. _classicapi_UndocumentedAPI lists what still has no descriptor. AddOns/!!!ClassicAPI/APIDocumentation/ ports Blizzard_APIDocumentation's eight files. Named /classicapi, not /api: the browser holds only what ClassicAPI adds, so /api would have implied the whole 1.12 surface. Two deliberate differences from the retail source, both noted in the file headers: a system search also matches its namespace, since that is the name people type; and an undocumented function says so, because an empty signature otherwise reads as a real one. LinkUtil gains the SetItemRef to LinkUtil.ProcessLink dispatch. That handler registry was dead code; a new link type now registers a handler instead of stacking another SetItemRef override. Also defines assertsafe there, which was undefined and only mattered once the function went live. Documented: the C_Spell and C_SpellBook surface, the spell globals, both spellbook enumerations, the 13 UNIT_SPELLCAST_* events, GameTooltip as the widget-method example and C_Glue as the glue and mixed-environment example. 66 of 692 function registrations. tools/New-ApiDocSkeletons.ps1 emits paste-ready skeletons to make the rest of the sweep tractable. Verified in game: the browser lists, searches, and prints detail; links render and click through; right-click copies and shift-click dumps.
91 lines
2.5 KiB
Lua
91 lines
2.5 KiB
Lua
-- Backport of Blizzard_APIDocumentation/FieldsAPIMixin.lua to vanilla 1.12 /
|
|
-- Lua 5.0.
|
|
--
|
|
-- Implementation differences from the retail source: none.
|
|
|
|
FieldsAPIMixin = CreateFromMixins(BaseAPIMixin);
|
|
|
|
function FieldsAPIMixin:GetParentName()
|
|
if self.Function then
|
|
return self.Function:GetName();
|
|
end
|
|
|
|
if self.Table then
|
|
return self.Table:GetName();
|
|
end
|
|
return "";
|
|
end
|
|
|
|
function FieldsAPIMixin:GetType()
|
|
return "field";
|
|
end
|
|
|
|
function FieldsAPIMixin:GetLinkHexColor()
|
|
return "ffdd55";
|
|
end
|
|
|
|
function FieldsAPIMixin:MatchesSearchString(searchString)
|
|
if self:GetLoweredName():match(searchString) then
|
|
return true;
|
|
end
|
|
|
|
if self:MatchesAnyDocumentation(searchString) then
|
|
return true;
|
|
end
|
|
|
|
return false;
|
|
end
|
|
|
|
function FieldsAPIMixin:GetLuaType()
|
|
if self.InnerType then
|
|
local complexType = APIDocumentation:FindAPIByName("table", self.InnerType);
|
|
return ("%s of %s"):format(self.Type, complexType and complexType:GenerateAPILink() or self.InnerType)
|
|
end
|
|
|
|
if self.EnumValue then
|
|
return self.EnumValue;
|
|
end
|
|
|
|
local complexType = APIDocumentation:FindAPIByName("table", self.Type);
|
|
return complexType and complexType:GenerateAPILink() or self.Type;
|
|
end
|
|
|
|
function FieldsAPIMixin:GetStrideIndex()
|
|
return self.StrideIndex;
|
|
end
|
|
|
|
function FieldsAPIMixin:IsOptional()
|
|
return self.Default ~= nil or self.Nilable;
|
|
end
|
|
|
|
function FieldsAPIMixin:GetSingleOutputLine()
|
|
local optionalString = "";
|
|
if self:IsOptional() then
|
|
if self.Default ~= nil then
|
|
optionalString = ("(default:%s) "):format(tostring(self.Default));
|
|
else
|
|
optionalString = "(optional) ";
|
|
end
|
|
end
|
|
if self.Documentation then
|
|
return ("%s%s %s - %s"):format(optionalString, self:GetLuaType(), self:GenerateAPILink(), table.concat(self.Documentation, " "));
|
|
end
|
|
return ("%s%s %s"):format(optionalString, self:GetLuaType(), self:GenerateAPILink());
|
|
end
|
|
|
|
function FieldsAPIMixin:GetArgumentString(decorateOptionals, includeColorCodes)
|
|
local prefix = decorateOptionals ~= false and self:IsOptional() and "optional " or "";
|
|
if includeColorCodes ~= false then
|
|
return ("|cff%s%s%s|r"):format(self:GetLinkHexColor(), prefix, self:GetName());
|
|
end
|
|
return ("%s%s"):format(prefix, self:GetName());
|
|
end
|
|
|
|
function FieldsAPIMixin:GetReturnString(decorateOptionals, includeColorCodes)
|
|
return self:GetArgumentString(decorateOptionals, includeColorCodes); -- Nothing special currently
|
|
end
|
|
|
|
function FieldsAPIMixin:GetPayloadString(decorateOptionals, includeColorCodes)
|
|
return self:GetReturnString(decorateOptionals, includeColorCodes); -- Nothing special currently
|
|
end
|