Add missing @group annotations (15e86c49) · Commits · public-projects / Nakama

server/runtime_go_nakama.go

+2 −0

Original line number	Diff line number	Diff line
		@@ -1957,6 +1957,7 @@ func (n RuntimeGoNakamaModule) StorageDelete(ctx context.Context, deletes []ru
		return err
		}

		// @group users
		// @summary Update account, storage, and wallet information simultaneously.
		// @param ctx(type=context.Context) The context object represents information about the server and requester.
		// @param accountUpdates(type=[]*runtime.AccountUpdate) Array of account information to be updated.
		@@ -3270,6 +3271,7 @@ func (n *RuntimeGoNakamaModule) UserGroupsList(ctx context.Context, userID strin
		return groups.UserGroups, groups.Cursor, nil
		}

		// @group events
		// @summary Generate an event.
		// @param ctx(type=context.Context) The context object represents information about the server and requester.
		// @param evt(type=*api.Event) The event to be generated.

server/runtime_javascript_nakama.go

+6 −1

Original line number	Diff line number	Diff line
		@@ -258,6 +258,7 @@ func (n runtimeJavascriptNakamaModule) mappings(r goja.Runtime) map[string]fun
		}
		}

		// @group utils
		// @summary Convert binary data to string.
		// @param data(type=Uint8Array) The binary data to be converted.
		// @return result(type=string) The resulting string.
		@@ -281,6 +282,7 @@ func (n runtimeJavascriptNakamaModule) binaryToString(r goja.Runtime) func(goj
		}
		}

		// @group utils
		// @summary Convert string data to binary.
		// @param str(type=string) The string to be converted.
		// @return result(type=Uint8Array) The resulting binary data.
		@@ -300,6 +302,7 @@ func (n runtimeJavascriptNakamaModule) stringToBinary(r goja.Runtime) func(goj
		}
		}

		// @group events
		// @summary Generate an event.
		// @param event_name(type=string) The name of the event to be created.
		// @param properties(type=[]string) An array of event properties.
		@@ -4280,6 +4283,7 @@ func (n runtimeJavascriptNakamaModule) storageDelete(r goja.Runtime) func(goja
		}
		}

		// @group users
		// @summary Update account, storage, and wallet information simultaneously.
		// @param accountUpdates(type=nkruntime.AccountUpdate) Array of account information to be updated.
		// @param storageWrites(type=nkruntime.StorageWriteRequest[]) Array of storage objects to be updated.
		@@ -4998,7 +5002,7 @@ func (n runtimeJavascriptNakamaModule) leaderboardsGetId(r goja.Runtime) func(
		}
		}

		// @group Leaderboards
		// @group leaderboards
		// @summary Fetch the list of leaderboard records around the owner.
		// @param id(type=string) The unique identifier for the leaderboard.
		// @param owner(type=string) The owner of the score to list records around. Mandatory field.
		@@ -6637,6 +6641,7 @@ func (n runtimeJavascriptNakamaModule) groupUsersAdd(r goja.Runtime) func(goja
		}
		}

		// @group groups
		// @summary Ban users from a group.
		// @param groupId(string) The ID of the group to ban users from.
		// @param userIds(string[]) Table array of user IDs to ban from this group.

server/runtime_lua_nakama.go

+2 −3

Original line number	Diff line number	Diff line
		@@ -501,15 +501,13 @@ func (n RuntimeLuaNakamaModule) runOnce(l lua.LState) int {
		return 0
		}

		// @summary Get the current runtime environment configuration.
		// @return ctx(table) Configuration details.
		// @return error(error) An optional error value if an error occurred.
		func (n RuntimeLuaNakamaModule) getContext(l lua.LState) int {
		ctx := NewRuntimeLuaContext(l, n.config.GetName(), RuntimeLuaConvertMapString(l, n.config.GetRuntime().Environment), RuntimeExecutionModeRunOnce, nil, nil, 0, "", "", nil, "", "", "", "")
		l.Push(ctx)
		return 1
		}

		// @group events
		// @summary Generate an event.
		// @param name(type=string) The name of the event to be created.
		// @param properties(type=OptTable) A table of event properties.
		@@ -5697,6 +5695,7 @@ func (n RuntimeLuaNakamaModule) storageDelete(l lua.LState) int {
		return 0
		}

		// @group users
		// @summary Update account, storage, and wallet information simultaneously.
		// @param accountUpdates(type=OptTable) List of account information to be updated.
		// @param storageWrites(type=OptTable) List of storage objects to be updated.