Hey,
I have a question to both users and Ansca team. How we can (using pearl script or Lua as an example) take detailed information Not only about API file list (which is quite easy) but also about rest of data from this site:
https://developer.anscamobile.com/resources/apis
As example what is shown on page and can be read:
https://developer.anscamobile.com/reference/index/mediaplaysound
Description:
Syntax:
Example:
Parameters:
Returns:
Remarks:
Related:
which is equivalent of LuaDoc:
--- Name of our beloved function
-- description
-- description
-- description
-- @param1 param1 Description
-- @param2 param2 Description
-- @return returnValue
-- @usage ExampleContent
-- @see Related Links
function module.functionName(param1, param2) return "whatReturn" end
and that would be all. This works great with Lua for IDEA plugin without any need to document anything in html file or other files…
If this is possible create link to such text file on every page. Then users can use standard “get API script” to read content not just display.newImageRect() without anything useful. This information is already on the site anyway…
maybe we should make a small community project to achieve that ? everyone takes 20 functions to describe and in no time we have fully documented SDK. Then using Lua it can be converted to any specific format required if somebody like to see offline docs. This can be done by LuaDoc engine very simple.
Regards,
Tom [import]uid: 111283 topic_id: 21541 reply_id: 85651[/import]