Skip to content

Fix some style issues in debugger documentation #5181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/07.DEBUGGER.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ typedef jerry_value_t
(*jerry_debugger_wait_for_source_callback_t) (const jerry_char_t *source_name_p,
size_t source_name_size,
const jerry_char_t *source_p,
size_t source_size, void *user_p);
size_t source_size,
void *user_p);
```

- `source_name_p` - source (usually a file) name of the source code
Expand Down Expand Up @@ -293,7 +294,8 @@ return value of the function.
```c
jerry_debugger_wait_for_source_status_t
jerry_debugger_wait_for_client_source (jerry_debugger_wait_for_source_callback_t callback_p,
void *user_p, jerry_value_t *return_value)
void *user_p,
jerry_value_t *return_value)
```

**Example**
Expand Down Expand Up @@ -385,7 +387,7 @@ Sends the program's output to the debugger client.

```c
void
jerry_debugger_send_output (const jerry_char_t *buffer, jerry_size_t string_size)
jerry_debugger_send_output (const jerry_char_t *buffer, jerry_size_t str_size)
```

**Example**
Expand Down
9 changes: 6 additions & 3 deletions docs/13.DEBUGGER-TRANSPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ the `header_p->next_p->send()` method.

```c
typedef bool (*jerry_debugger_transport_send_t) (struct jerry_debugger_transport_interface_t *header_p,
uint8_t *message_p, size_t message_length);
uint8_t *message_p,
size_t message_length);
```

## jerry_debugger_transport_receive_t
Expand Down Expand Up @@ -107,8 +108,10 @@ will be the first item of the interface chain.

```c
void jerry_debugger_transport_add (jerry_debugger_transport_header_t *header_p,
size_t send_message_header_size, size_t max_send_message_size,
size_t receive_message_header_size, size_t max_receive_message_size);
size_t send_message_header_size,
size_t max_send_message_size,
size_t receive_message_header_size,
size_t max_receive_message_size);
```

- `header_p`: header of a transportation interface.
Expand Down
Loading