mrdocs::RecordInterface

The aggregated interface for a given struct, class, or union.

Synopsis

Declared in <mrdocs/Metadata/Symbol/RecordInterface.hpp>

class RecordInterface;

Description

This class represents the public, protected, and private interfaces of a record. It is used to generate the "interface" value of the DOM for symbols that represent records or namespaces.

The interface is not part of the Corpus. It is a temporary structure generated to aggregate the symbols of a record. This structure is provided to the user via the DOM.

While the members of a Namespace are directly represented with a Tranche, the members of a Record are represented with an Interface.

Data Members

Name

Description

Private

The aggregated private interfaces.

Protected

The aggregated protected interfaces.

Public

The aggregated public interfaces.

Created with MrDocs