From 07b71f8f789624b8957f18ea5d1f858914082d5c Mon Sep 17 00:00:00 2001 From: Sami Vaarala Date: Sat, 27 Feb 2016 18:49:32 +0200 Subject: [PATCH] duk_debugger_pause() API doc rewording --- website/api/duk_debugger_pause.yaml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/website/api/duk_debugger_pause.yaml b/website/api/duk_debugger_pause.yaml index 6dd9e274..8074d603 100644 --- a/website/api/duk_debugger_pause.yaml +++ b/website/api/duk_debugger_pause.yaml @@ -4,20 +4,20 @@ proto: | void duk_debugger_pause(duk_context *ctx); summary: | -

Trigger a debugger pause as soon as possible. In most cases Duktape pauses - immediately; however if a native call such as a Duktape/C function is in - progress or no Ecmascript code is currently executing, the pause will be - triggered the next time Ecmascript bytecode is executed. This may take some - time e.g. if the native call in progress is long-running.

+

Request a debugger pause as soon as possible and return without blocking. + The pause will be triggered the next time Ecmascript bytecode is executed, + which is usually almost immediate. However, if a native call such as a + Duktape/C function is in progress or no Ecmascript code is currently + executing, it may take longer for the pause to take effect.

-

If debugger support has not been compiled in, or if the debugger is not - attached, the call is a no-op. This mimics the semantics of the Ecmascript - debugger statement.

+

The call is a no-op if (1) debugger support has not been compiled in, (2) + the debugger is not attached, or (3) Duktape is already paused. This mimics + the semantics of the Ecmascript debugger statement.

Like all Duktape API calls, this call is not thread safe. It may be tempting - to want to trigger a pause from a thread different than one running Ecmascript - code for the context, but this is unsafe and must be avoided. + to trigger a pause from a thread different than one running Ecmascript code + for the context, but this is unsafe and not currently supported.
example: |