WoWInterface

WoWInterface (https://www.wowinterface.com/forums/index.php)
-   General Authoring Discussion (https://www.wowinterface.com/forums/forumdisplay.php?f=20)
-   -   Blizzard_APIDocumentation? (https://www.wowinterface.com/forums/showthread.php?t=55997)

zork 01-25-18 11:26 PM

Blizzard_APIDocumentation?
 
I'm looking through the latest API changes and found that Blizzard added a new addon with 7.2 called: Blizzard_APIDocumentation

https://github.com/tomrus88/Blizzard...IDocumentation

What is this thing and how can be benefit from it?

*edit* Oh...
http://www.wowinterface.com/forums/s...ad.php?t=55257
https://www.townlong-yak.com/framexm...IDocumentation

WoW API changelog
https://wow.gamepedia.com/Patch_7.0.3/API_changes
https://wow.gamepedia.com/Patch_7.1.0/API_changes
https://wow.gamepedia.com/Patch_7.2.0/API_changes
https://wow.gamepedia.com/Patch_7.3.0/API_changes

kurapica.igas 01-26-18 12:24 AM

1 Attachment(s)
Things like Attachment 9031 maybe, it's hard to keep those datas up-to-date in the old days.

Tim 01-26-18 12:01 PM

From what I can remember is it will allow you to look up documentation via the client instead of 3rd party sites. Not sure if this will extend to events, etc. but, it's a good start.

Fizzlemizz 01-26-18 02:10 PM

Just looking at the UnitDocumentation.lua from 7.3.5 to 8.0 they seem to be adding events and enum tables although it doesn't seem to list function returns to chat even though they are in the code.

Resike 01-27-18 01:53 AM

This looks very weak, feels like even my documentation is more useful. (Currently working on Widget Reference):
https://github.com/Resike/BlizzardIn...ster/Resources

Also i'm not sure whats the point listing the type of arguments/return values and nilability, since it's Lua. It can be table, string or number (or nil) and 99,9% of the time you can tell what it is just by it's name.

Personally i would like to see something like this, and this is what i'm also aiming for:

Lua Code:
  1. GetPlayerMapPosition = { -- Returns the position of a unit on the current map
  2.     args = {
  3.         unit, -- The unitID for which the position is returned (string)
  4.     }
  5.     returns = {
  6.         x, -- X value of the unit position (a proportion between 0 and 1, relative to WorldMapDetailFrame) (number)
  7.         y, -- Y value of the unit position (a proportion between 0 and 1, relative to WorldMapDetailFrame) (number)
  8.     }
  9. }

And only add the arg/return types if done with everything.


All times are GMT -6. The time now is 12:27 PM.

vBulletin © 2024, Jelsoft Enterprises Ltd
© 2004 - 2022 MMOUI