doc,inspector: use code markup/markdown in headers

PR-URL: #31086 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
nodejs · Jan 3, 2020 · 699b31f · 699b31f
1 parent 3571df3
commit 699b31f
Showing 1 changed file with 13 additions and 13 deletions.
diff --git a/doc/api/inspector.md b/doc/api/inspector.md
@@ -12,11 +12,11 @@ It can be accessed using:
 const inspector = require('inspector');
 ```
 
-## inspector.close()
+## `inspector.close()`
 
 Deactivate the inspector. Blocks until there are no active connections.
 
-## inspector.console
+## `inspector.console`
 
 * {Object} An object to send messages to the remote inspector console.
 
@@ -27,7 +27,7 @@ require('inspector').console.log('a message');
 The inspector console does not have API parity with Node.js
 console.
 
-## inspector.open(\[port\[, host\[, wait\]\]\])
+## `inspector.open([port[, host[, wait]]])`
 
 * `port` {number} Port to listen on for inspector connections. Optional.
   **Default:** what was specified on the CLI.
@@ -46,7 +46,7 @@ and flow control has been passed to the debugger client.
 See the [security warning](cli.html#inspector_security) regarding the `host`
 parameter usage.
 
-## inspector.url()
+## `inspector.url()`
 
 * Returns: {string|undefined}
 
@@ -67,7 +67,7 @@ $ node -p 'inspector.url()'
 undefined
 ```
 
-## inspector.waitForDebugger()
+## `inspector.waitForDebugger()`
 <!-- YAML
 added: v12.7.0
 -->
@@ -77,14 +77,14 @@ Blocks until a client (existing or connected later) has sent
 
 An exception will be thrown if there is no active inspector.
 
-## Class: inspector.Session
+## Class: `inspector.Session`
 
 * Extends: {EventEmitter}
 
 The `inspector.Session` is used for dispatching messages to the V8 inspector
 back-end and receiving message responses and notifications.
 
-### Constructor: new inspector.Session()
+### Constructor: `new inspector.Session()`
 <!-- YAML
 added: v8.0.0
 -->
@@ -93,7 +93,7 @@ Create a new instance of the `inspector.Session` class. The inspector session
 needs to be connected through [`session.connect()`][] before the messages
 can be dispatched to the inspector backend.
 
-### Event: 'inspectorNotification'
+### Event: `'inspectorNotification'`
 <!-- YAML
 added: v8.0.0
 -->
@@ -110,7 +110,7 @@ session.on('inspectorNotification', (message) => console.log(message.method));
 
 It is also possible to subscribe only to notifications with specific method:
 
-### Event: &lt;inspector-protocol-method&gt;
+### Event: `<inspector-protocol-method>`;
 <!-- YAML
 added: v8.0.0
 -->
@@ -131,22 +131,22 @@ session.on('Debugger.paused', ({ params }) => {
 // [ '/the/file/that/has/the/breakpoint.js:11:0' ]
 ```
 
-### session.connect()
+### `session.connect()`
 <!-- YAML
 added: v8.0.0
 -->
 
 Connects a session to the inspector back-end.
 
-### session.connectToMainThread()
+### `session.connectToMainThread()`
 <!-- YAML
 added: v12.11.0
 -->
 
 Connects a session to the main thread inspector back-end. An exception will
 be thrown if this API was not called on a Worker thread.
 
-### session.disconnect()
+### `session.disconnect()`
 <!-- YAML
 added: v8.0.0
 -->
@@ -156,7 +156,7 @@ with an error. [`session.connect()`][] will need to be called to be able to send
 messages again. Reconnected session will lose all inspector state, such as
 enabled agents or configured breakpoints.
 
-### session.post(method\[, params\]\[, callback\])
+### `session.post(method[, params][, callback])`
 <!-- YAML
 added: v8.0.0
 -->