Add missing LuaDoc to all functions and improve assertions messages (#33)

Author: aglitchman

README.md

@@ -280,6 +280,9 @@ And it's also a good idea to upload a demo build of YaGames to your game's draft
 | `ysdk.screen.fullscreen.status` | `yagames.screen_fullscreen_status()`<br>Returns `"on"` or `"off"` |
 | `ysdk.screen.fullscreen.request()` | `yagames.screen_fullscreen_request([callback])` |
 | `ysdk.screen.fullscreen.exit()` | `yagames.screen_fullscreen_exit([callback])` |
+| **Shortcuts** [(docs)](https://yandex.ru/dev/games/doc/ru/sdk/sdk-shortcut) |  |
+| `ysdk.shortcut.canShowPrompt()` | `yagames.shortcut_can_show_prompt(callback)`<br>The callback result is a table `{ canShow = boolean }` |
+| `ysdk.shortcut.showPrompt()` | `yagames.shortcut_show_prompt(callback)`<br>The callback result is a table `{ outcome = "string" }` |
 | **Safe Storage** [(docs)](https://yandex.ru/dev/games/doc/en/sdk/sdk-player#progress-loss) | *Note: `key` and `value` should be valid UTF-8 strings. Storing strings with zero bytes aren't supported.* |
 | `ysdk.getStorage()` | `yagames.storage_init(callback)` |
 | - `safeStorage.getItem(key)` | `yagames.storage_get_item(key)`<br>Returns that key's value or `nil`. |

game.project

@@ -11,10 +11,10 @@ high_dpi = 1
 
 [project]
 title = yagames
-version = 0.15.0
+version = 0.16.0
 developer = Indiesoft LLC
 bundle_resources = example/bundle/
-dependencies#0 = https://github.com/subsoap/defos/archive/v2.5.0.zip
+dependencies#0 = https://github.com/subsoap/defos/archive/v2.8.1.zip
 dependencies#1 = https://github.com/Insality/druid/archive/0.6.0.zip
 dependencies#2 = https://github.com/britzl/ludobits/archive/7.1.0.zip
 

yagames/helpers/mock.lua

@@ -617,27 +617,6 @@ function M.get_flags(cb_id, options)
     M.send(cb_id, NO_ERR, rxi_json.encode(result))
 end
 
---- DEPRECATED
-function M.banner_init(cb_id)
-    M.send(cb_id, "Error loading SDK.")
-end
-
---- DEPRECATED
-function M.banner_create(rtb_id, options, cb_id)
-end
-
---- DEPRECATED
-function M.banner_refresh(rtb_id, cb_id)
-end
-
---- DEPRECATED
-function M.banner_destroy(rtb_id)
-end
-
---- DEPRECATED
-function M.banner_set(rtb_id, property, value)
-end
-
 return {
     enable = function()
         if not yagames_private then

yagames/lib/web/lib_yagames.js

@@ -965,12 +965,7 @@ var LibYaGamesPrivate = {
         } catch (err) {
 
         }
-    },
-
-    YaGamesPrivate_Banner_Init: function (cb_id) {
-        var self = YaGamesPrivate;
-        self.delaySend(cb_id, "DEPRECATED.");
-    },
+    }
 };
 
 autoAddDeps(LibYaGamesPrivate, "$YaGamesPrivate");

yagames/src/main.cpp

@@ -81,7 +81,6 @@ extern "C"
     void YaGamesPrivate_Event_Dispatch(const char* cevent_name);
     void YaGamesPrivate_Event_On(const char* cevent_name, const int cb_id);
     void YaGamesPrivate_GetFlags(const int cb_id, const char* coptions);
-    void YaGamesPrivate_Banner_Init(const int cb_id);
 }
 
 struct YaGamesPrivateListener
@@ -848,37 +847,6 @@ static int GetFlags(lua_State* L)
     return 0;
 }
 
-//
-// DEPRECATED
-// Banner Ads API
-//
-
-static int Banner_Init(lua_State* L)
-{
-    YaGamesPrivate_Banner_Init(luaL_checkint(L, 1));
-    return 0;
-}
-
-static int Banner_Create(lua_State* L)
-{
-    return 0;
-}
-
-static int Banner_Destroy(lua_State* L)
-{
-    return 0;
-}
-
-static int Banner_Refresh(lua_State* L)
-{
-    return 0;
-}
-
-static int Banner_Set(lua_State* L)
-{
-    return 0;
-}
-
 //
 //
 //
@@ -965,13 +933,6 @@ static const luaL_reg Module_methods[] = {
     { "event_on", Event_On },
     // - Config
     { "get_flags", GetFlags },
-    // DEPRECATED
-    // - Banner Ads
-    { "banner_init", Banner_Init },
-    { "banner_create", Banner_Create },
-    { "banner_destroy", Banner_Destroy },
-    { "banner_refresh", Banner_Refresh },
-    { "banner_set", Banner_Set },
     { 0, 0 }
 };