Unverified Commit 5ba84990 authored by Tom Glenn's avatar Tom Glenn Committed by GitHub
Browse files

Fix order of doc comments for stream runtime functions (#868)

parent 574369e1

server/runtime_javascript_nakama.go

+5 −5
Original line number Diff line number Diff line
@@ -2681,9 +2681,9 @@ func (n *runtimeJavascriptNakamaModule) streamUserList(r *goja.Runtime) func(goj 


// @group streams

// @summary Retreive a stream presence and metadata by user ID.

// @param stream(type=nkruntime.Stream) A stream object.

// @param userId(type=string) The user ID to fetch information for.

// @param sessionId(type=string) The current session ID for the user.

// @param stream(type=nkruntime.Stream) A stream object.

// @return meta(nkruntime.Presence) Presence for the user.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) streamUserGet(r *goja.Runtime) func(goja.FunctionCall) goja.Value {
@@ -2733,9 +2733,9 @@ func (n *runtimeJavascriptNakamaModule) streamUserGet(r *goja.Runtime) func(goja 


// @group streams

// @summary Add a user to a stream.

// @param stream(type=nkruntime.Stream) A stream object.

// @param userId(type=string) The user ID to be added.

// @param sessionId(type=string) The current session ID for the user.

// @param stream(type=nkruntime.Stream) A stream object.

// @param hidden(type=bool) Whether the user will be marked as hidden.

// @param persistence(type=bool) Whether message data should be stored in the database.

// @param status(type=string) User status message.
@@ -2805,9 +2805,9 @@ func (n *runtimeJavascriptNakamaModule) streamUserJoin(r *goja.Runtime) func(goj 


// @group streams

// @summary Update a stream user by ID.

// @param stream(type=nkruntime.Stream) A stream object.

// @param userId(type=string) The user ID to be updated.

// @param sessionId(type=string) The current session ID for the user.

// @param stream(type=nkruntime.Stream) A stream object.

// @param hidden(type=bool) Whether the user will be marked as hidden.

// @param persistence(type=bool) Whether message data should be stored in the database.

// @param status(type=string) User status message.
@@ -2876,9 +2876,9 @@ func (n *runtimeJavascriptNakamaModule) streamUserUpdate(r *goja.Runtime) func(g 


// @group streams

// @summary Remove a user from a stream.

// @param stream(type=nkruntime.Stream) A stream object.

// @param userId(type=string) The user ID to be removed.

// @param sessionId(type=string) The current session ID for the user.

// @param stream(type=nkruntime.Stream) A stream object.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) streamUserLeave(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -2921,8 +2921,8 @@ func (n *runtimeJavascriptNakamaModule) streamUserLeave(r *goja.Runtime) func(go 


// @group streams

// @summary Kick a user from a stream.

// @param stream(type=nkruntime.Stream) A stream object.

// @param presence(type=nkruntime.Presence) The presence to be kicked.

// @param stream(type=nkruntime.Stream) A stream object.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) streamUserKick(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {

server/runtime_lua_nakama.go

+5 −5
Original line number Diff line number Diff line
@@ -3457,9 +3457,9 @@ func (n *RuntimeLuaNakamaModule) streamUserList(l *lua.LState) int { 


// @group streams

// @summary Retreive a stream presence and metadata by user ID.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @param userId(type=string) The user ID to fetch information for.

// @param sessionId(type=string) The current session ID for the user.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @return meta(table) Presence and metadata for the user.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeLuaNakamaModule) streamUserGet(l *lua.LState) int {
@@ -3563,9 +3563,9 @@ func (n *RuntimeLuaNakamaModule) streamUserGet(l *lua.LState) int { 


// @group streams

// @summary Add a user to a stream.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @param userId(type=string) The user ID to be added.

// @param sessionId(type=string) The current session ID for the user.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @param hidden(type=bool, optional=true, default=false) Whether the user will be marked as hidden.

// @param persistence(type=bool, optional=true, default=true) Whether message data should be stored in the database.

// @param status(type=string, optional=true) User status message.
@@ -3683,9 +3683,9 @@ func (n *RuntimeLuaNakamaModule) streamUserJoin(l *lua.LState) int { 


// @group streams

// @summary Update a stream user by ID.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @param userId(type=string) The user ID to be updated.

// @param sessionId(type=string) The current session ID for the user.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @param hidden(type=bool, optional=true, default=false) Whether the user will be marked as hidden.

// @param persistence(type=bool, optional=true, default=true) Whether message data should be stored in the database.

// @param status(type=string, optional=true) User status message.
@@ -3800,9 +3800,9 @@ func (n *RuntimeLuaNakamaModule) streamUserUpdate(l *lua.LState) int { 


// @group streams

// @summary Remove a user from a stream.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @param userId(type=string) The user ID to be removed.

// @param sessionId(type=string) The current session ID for the user.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeLuaNakamaModule) streamUserLeave(l *lua.LState) int {

	// Parse input User ID.
@@ -3898,8 +3898,8 @@ func (n *RuntimeLuaNakamaModule) streamUserLeave(l *lua.LState) int { 


// @group streams

// @summary Kick user(s) from a stream.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @param presence(type=table) The presence(s) to be kicked.

// @param stream(type=table) A stream object consisting of a `mode` (int), `subject` (string), `descriptor` (string) and `label` (string).

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeLuaNakamaModule) streamUserKick(l *lua.LState) int {

	// Parse presence.