Skip to content

Commit 367d561

Browse files
committed
Correct formatting in function doc comment
1 parent 2c42736 commit 367d561

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

src/LaunchServer.lua

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,15 @@ ConPrintf("Opening URL: %s", url)
9595
OpenURL(url)
9696

9797
--- Handle an incoming socket connection, to complete an OAuth redirect.
98-
--- @param client table The socket connection to handle, as returned by `server:accept()`.
99-
--- @param attempt number The number of attempts made to handle an incoming connection. This is used for logging
98+
--- @param client table @The socket connection to handle, as returned by `server:accept()`.
99+
--- @param attempt number @The number of attempts made to handle an incoming connection. This is used for logging
100100
--- purposes, since spurious issues can be difficult to identify otherwise.
101-
--- @return boolean shouldRetry Whether we should wait for another connection. If false, we've successfully responded to
102-
--- a HTTP request. Note that, for the purposes of this function, we don't care whether authorization was *granted*,
101+
--- @return boolean shouldRetry @Whether we should wait for another connection. If false, we've successfully responded
102+
--- to a HTTP request. Note that, for the purposes of this function, we don't care whether authorization was *granted*,
103103
--- just that the process itself was completed and the user was redirected as intended.
104-
--- @return string? code The OAuth authorization code. This is exchanged for an access token and refresh token later.
105-
--- @return string? state The OAuth state string. This is a sentinel value used to ensure that a request hasn't been
106-
-- forged.
104+
--- @return string? code @The OAuth authorization code. This is exchanged for an access token and refresh token later.
105+
--- @return string? state @The OAuth state string. This is a sentinel value used to ensure that a request hasn't been
106+
--- forged.
107107
function handleConnection(client, attempt)
108108
local shouldRetry, code, state = true, nil, nil
109109

0 commit comments

Comments
 (0)