From 72963c4e20436b7c9b08b4d36463896dceed3ab2 Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Tue, 14 Mar 2023 08:29:39 -0400 Subject: [PATCH] Commentary (#4020) --- docs/guide/connecting.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/guide/connecting.rst b/docs/guide/connecting.rst index 9762e264a..10b35eec9 100644 --- a/docs/guide/connecting.rst +++ b/docs/guide/connecting.rst @@ -120,6 +120,15 @@ code. This is a feature, as using the SystemC pin interconnect scheme everywhere would reduce performance by an order of magnitude. +Verilated API +============= + +The API to a Verilated model is the C++ headers in the include/ directory +in the distribution. These headers use Doxygen comments, `///` and `//<`, +to indicate and document those functions that are part of the Verilated +public API. + + Direct Programming Interface (DPI) ==================================