Example: NaturalDocs, modules & diagrams

This page is generated from the NaturalDocs-style fixtures (tests/fixtures/sv/nd_pkg.sv and counter.sv) with sv_doc_style = "naturaldocs". It exercises detached-block association, member groups, an inheritance diagram, and module ports/parameters.

A class hierarchy with groups and a diagram

class nd_leaf  extends nd_mid

A concrete leaf class.

Operation

function run(int cycles)

Runs the leaf for cycles cycles.

class nd_base

The root of the nd_pkg hierarchy.

Identification

function get_name()

Returns the object name. See set_name.

function set_name(string name)

Sets the object name.

A module with parameters and ports

module counter

The counter value used with the select_sequence() API in UVM_SEQ_LIB_USER mode

parameter int WIDTH = 8

counter width in bits

localparam int MAX = (1 << WIDTH) - 1

input logic clk

clock

input logic rst

active-high synchronous reset

output logic [WIDTH-1:0] count