From f6ccdbdddd163c888156a6c9bbd1aee563e33a67 Mon Sep 17 00:00:00 2001
From: Akos Kiss <akiss@inf.u-szeged.hu>
Date: Tue, 21 Aug 2018 09:42:56 +0200
Subject: [PATCH] Doctest debugger examples and fix revealed issues (#2475)

This will help to keep the debugger documentation up to date.
(Note: only compilation & linking is possible as execution would
require a connecting debugger client, which is not supported for
unit/doctests.)

JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
---
 docs/07.DEBUGGER.md | 62 +++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 57 insertions(+), 5 deletions(-)

diff --git a/docs/07.DEBUGGER.md b/docs/07.DEBUGGER.md
index 5049a4f12..60aa2618d 100644
--- a/docs/07.DEBUGGER.md
+++ b/docs/07.DEBUGGER.md
@@ -124,7 +124,14 @@ jerry_debugger_is_connected (void);
 
 **Example**
 
+[doctest]: # (test="link")
+
 ```c
+#include "jerryscript.h"
+#include "jerryscript-ext/debugger.h"
+
+int
+main (void)
 {
   jerry_init (JERRY_INIT_EMPTY);
   jerryx_debugger_after_connect (jerryx_debugger_tcp_create (5001)
@@ -157,7 +164,14 @@ jerry_debugger_stop (void)
 
 **Example**
 
+[doctest]: # (test="link")
+
 ```c
+#include "jerryscript.h"
+#include "jerryscript-ext/debugger.h"
+
+int
+main (void)
 {
   jerry_init (JERRY_INIT_EMPTY);
   jerryx_debugger_after_connect (jerryx_debugger_tcp_create (5001)
@@ -192,7 +206,14 @@ jerry_debugger_continue (void)
 
 **Example**
 
+[doctest]: # (test="link")
+
 ```c
+#include "jerryscript.h"
+#include "jerryscript-ext/debugger.h"
+
+int
+main (void)
 {
   jerry_init (JERRY_INIT_EMPTY);
   jerryx_debugger_after_connect (jerryx_debugger_tcp_create (5001)
@@ -227,7 +248,15 @@ jerry_debugger_stop_at_breakpoint (bool enable_stop_at_breakpoint)
 
 **Example**
 
+[doctest]: # (test="link")
+
 ```c
+#include <string.h>
+#include "jerryscript.h"
+#include "jerryscript-ext/debugger.h"
+
+int
+main (void)
 {
   jerry_init (JERRY_INIT_EMPTY);
   jerryx_debugger_after_connect (jerryx_debugger_tcp_create (5001)
@@ -236,7 +265,9 @@ jerry_debugger_stop_at_breakpoint (bool enable_stop_at_breakpoint)
   jerry_debugger_stop_at_breakpoint (true);
 
   // Protected execution of JavaScript code.
-  jerry_eval (...);
+  const jerry_char_t script[] = "42";
+  size_t script_size = strlen ((const char *) script);
+  jerry_eval (script, script_size, JERRY_PARSE_NO_OPTS);
 
   jerry_debugger_stop_at_breakpoint (false);
 
@@ -264,7 +295,12 @@ jerry_debugger_wait_for_client_source (jerry_debugger_wait_for_source_callback_t
 
 **Example**
 
+[doctest]: # (test="link")
+
 ```c
+#include "jerryscript.h"
+#include "jerryscript-ext/debugger.h"
+
 /**
  * Runs the source code received by jerry_debugger_wait_for_client_source.
  */
@@ -291,8 +327,11 @@ wait_for_source_callback (const jerry_char_t *resource_name_p, /**< resource nam
   return ret_val;
 } /* wait_for_source_callback */
 
-int main ()
+int
+main (void)
 {
+  jerry_debugger_wait_for_source_status_t receive_status;
+
   do
   {
     /* Create a new JerryScript instance when a context reset is
@@ -305,7 +344,6 @@ int main ()
     do
     {
       jerry_value_t run_result;
-      jerry_debugger_wait_for_source_status_t receive_status;
 
       receive_status = jerry_debugger_wait_for_client_source (wait_for_source_callback,
                                                               NULL,
@@ -342,13 +380,20 @@ jerry_debugger_send_output (jerry_char_t buffer[], jerry_size_t string_size)
 
 **Example**
 
+[doctest]: # (test="link")
+
 ```c
+#include "jerryscript.h"
+#include "jerryscript-ext/debugger.h"
+
+int
+main (void)
 {
   jerry_init (JERRY_INIT_EMPTY);
   jerryx_debugger_after_connect (jerryx_debugger_tcp_create (5001)
                                  && jerryx_debugger_ws_create ());
 
-  jerry_char_t my_output = "Hey, this should be sent too!";
+  jerry_char_t my_output[] = "Hey, this should be sent too!";
   jerry_size_t my_output_size = sizeof (my_output);
 
   jerry_debugger_send_output (my_output, my_output_size);
@@ -372,13 +417,20 @@ jerry_debugger_send_log (jerry_log_level_t level, jerry_char_t buffer[], jerry_s
 
 **Example**
 
+[doctest]: # (test="link")
+
 ```c
+#include "jerryscript.h"
+#include "jerryscript-ext/debugger.h"
+
+int
+main (void)
 {
   jerry_init (JERRY_INIT_EMPTY);
   jerryx_debugger_after_connect (jerryx_debugger_tcp_create (5001)
                                  && jerryx_debugger_ws_create ());
 
-  jerry_char_t my_log = "Custom diagnostics";
+  jerry_char_t my_log[] = "Custom diagnostics";
   jerry_size_t my_log_size = sizeof (my_log);
 
   jerry_debugger_send_log (JERRY_LOG_LEVEL_DEBUG, my_log, my_log_size);