SwiftDocC
CommunicationBridge

Protocol

CommunicationBridge

A bridge that provides bi-directional communication with a documentation renderer.

protocol CommunicationBridge

Discussion

Use a communication bridge to send and receive messages between an IDE and an embedded documentation renderer.

Topics

Associated Types

associatedtype SendHandler
Handler for sending messages.

Instance Properties

var onReceiveMessage: ((Message) -> ())?
A closure that the communication bridge calls when it receives a message.

Instance Methods

func send(Message, using: Self.SendHandler) throws
Sends a message to the documentation renderer using the given handler.