Skip to content

Commit 30ee4ac

Browse files
TrottMylesBorins
authored andcommitted
doc,inspector: use code markup/markdown in headers
Backport-PR-URL: #31108 PR-URL: #31086 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 6e45e32 commit 30ee4ac

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/api/inspector.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ It can be accessed using:
1212
const inspector = require('inspector');
1313
```
1414

15-
## inspector.close()
15+
## `inspector.close()`
1616

1717
Deactivate the inspector. Blocks until there are no active connections.
1818

19-
## inspector.console
19+
## `inspector.console`
2020

2121
* {Object} An object to send messages to the remote inspector console.
2222

@@ -27,7 +27,7 @@ require('inspector').console.log('a message');
2727
The inspector console does not have API parity with Node.js
2828
console.
2929

30-
## inspector.open(\[port\[, host\[, wait\]\]\])
30+
## `inspector.open([port[, host[, wait]]])`
3131

3232
* `port` {number} Port to listen on for inspector connections. Optional.
3333
**Default:** what was specified on the CLI.
@@ -46,13 +46,13 @@ and flow control has been passed to the debugger client.
4646
See the [security warning](cli.html#inspector_security) regarding the `host`
4747
parameter usage.
4848

49-
## inspector.url()
49+
## `inspector.url()`
5050

5151
* Returns: {string|undefined}
5252

5353
Return the URL of the active inspector, or `undefined` if there is none.
5454

55-
## inspector.waitForDebugger()
55+
## `inspector.waitForDebugger()`
5656
<!-- YAML
5757
added: v12.7.0
5858
-->
@@ -62,14 +62,14 @@ Blocks until a client (existing or connected later) has sent
6262

6363
An exception will be thrown if there is no active inspector.
6464

65-
## Class: inspector.Session
65+
## Class: `inspector.Session`
6666

6767
* Extends: {EventEmitter}
6868

6969
The `inspector.Session` is used for dispatching messages to the V8 inspector
7070
back-end and receiving message responses and notifications.
7171

72-
### Constructor: new inspector.Session()
72+
### Constructor: `new inspector.Session()`
7373
<!-- YAML
7474
added: v8.0.0
7575
-->
@@ -78,7 +78,7 @@ Create a new instance of the `inspector.Session` class. The inspector session
7878
needs to be connected through [`session.connect()`][] before the messages
7979
can be dispatched to the inspector backend.
8080

81-
### Event: 'inspectorNotification'
81+
### Event: `'inspectorNotification'`
8282
<!-- YAML
8383
added: v8.0.0
8484
-->
@@ -95,7 +95,7 @@ session.on('inspectorNotification', (message) => console.log(message.method));
9595

9696
It is also possible to subscribe only to notifications with specific method:
9797

98-
### Event: &lt;inspector-protocol-method&gt;
98+
### Event: `<inspector-protocol-method>`;
9999
<!-- YAML
100100
added: v8.0.0
101101
-->
@@ -116,22 +116,22 @@ session.on('Debugger.paused', ({ params }) => {
116116
// [ '/the/file/that/has/the/breakpoint.js:11:0' ]
117117
```
118118

119-
### session.connect()
119+
### `session.connect()`
120120
<!-- YAML
121121
added: v8.0.0
122122
-->
123123

124124
Connects a session to the inspector back-end.
125125

126-
### session.connectToMainThread()
126+
### `session.connectToMainThread()`
127127
<!-- YAML
128128
added: v12.11.0
129129
-->
130130

131131
Connects a session to the main thread inspector back-end. An exception will
132132
be thrown if this API was not called on a Worker thread.
133133

134-
### session.disconnect()
134+
### `session.disconnect()`
135135
<!-- YAML
136136
added: v8.0.0
137137
-->
@@ -141,7 +141,7 @@ with an error. [`session.connect()`][] will need to be called to be able to send
141141
messages again. Reconnected session will lose all inspector state, such as
142142
enabled agents or configured breakpoints.
143143

144-
### session.post(method\[, params\]\[, callback\])
144+
### `session.post(method[, params][, callback])`
145145
<!-- YAML
146146
added: v8.0.0
147147
-->

0 commit comments

Comments
 (0)