Main Content

clibgen.OpaqueTypeDefinition class

Package: clibgen

Definition for MATLAB type corresponding to C++ opaque type

Description

Use a OpaqueTypeDefinition object to represent typedef void* in the C++ library.

The clibgen.OpaqueTypeDefinition class is a handle class.

Creation

MATLAB® constructs a OpaqueTypeDefinition object when MATLAB calls addOpaqueType on a clibgen.LibraryDefinition object.

Properties

expand all

Help text for the end user describing the opaque type, specified as a string or a character vector. The publisher can modify the value of the Description property in the library definition file.

Example:

Attributes:

GetAccess
public
SetAccess
public

Opaque type name in MATLAB, specified as a string or a character vector.

Attributes:

GetAccess
public
SetAccess
private

Opaque type signature, specified as a string or a character vector.

Example:

Attributes:

GetAccess
public
SetAccess
private

Library defining the opaque type, specified as a clibgen.LibraryDefinition object.

Attributes:

GetAccess
public
SetAccess
private

Help text from C++ header file for the end user describing details about the opaque type, specified as a string or a character vector. If the C++ comment does not contain detailed information, then DetailedDescription does not appear in the definition file.

The publisher can modify the value of the DetailedDescription property in the library definition file. If DetailedDescription is not empty, then the MATLAB doc command displays this sentence before displaying the value of DetailedDescription.

This content is from the external library documentation.

Attributes:

GetAccess
public
SetAccess
public
Introduced in R2021a