clibgen.api.MethodDefinition

R2026b

MATLAB definition for C++ class method

Since R2026b

Description

A clibgen.api.MethodDefinition object represents the MATLAB^® definition of a C++ method.

Creation

methDef = clsDef.Methods creates a method definition object from the Methods property of a clibgen.api.ClassDefinition object.

methDef = clsDef.IncompleteMethods creates a method definition object from the IncompleteMethods property.

Properties

CPPName — C++ class method name

Read-only: string scalar

This property is read-only.

C++ class method name, represented as a string scalar.

MATLABName — MATLAB name for C++ method

string scalar

MATLAB name for the C++ method, specified as a string scalar.

OwningClassName — Fully qualified name of C++ class that contains method

Read-only: string scalar

This property is read-only.

Fully qualified name of the C++ class that contains the method, represented as a string scalar.

CPPSignature — C++ signature

Read-only: string scalar

This property is read-only.

C++ signature, represented as a string scalar.

MATLABSignature — MATLAB signature of method

Read-only: string scalar

This property is read-only.

MATLAB signature of the method, represented as a string scalar.

CPPInputs — Parameter definitions

Read-only: clibgen.api.InputArgumentDefinition object

This property is read-only.

MATLAB definition of C++ parameters, represented as a clibgen.api.InputArgumentDefinition object.

CPPOutput — MATLAB definition of return argument

Read-only: clibgen.api.OutputArgumentDefinition object

This property is read-only.

MATLAB definition of the C++ return argument, represented as a clibgen.api.OutputArgumentDefinition object.

Status — Whether method needs definition

Read-only: Complete (default) | Incomplete

This property is read-only.

Whether method needs definition, represented as Complete or Incomplete.

Included — Whether construct is included in interface

true or 1 (default) | false or 0

Whether this construct is included in the interface, specified as a numeric or logical 1 (true) or 0 (false).

Overloaded — Whether method is overloaded

Read-only: true | false

This property is read-only.

Whether method is overloaded, represented as true or false.

Static — Whether method is static

Read-only: true | false

This property is read-only.

Whether method is static, represented as true or false.

Description — Doxygen @brief comments

string scalar

Doxygen @brief comments for the class method from the header file, specified as a string scalar. If the header file does not contain @brief comments, the text for Description is:

MATLABName    Representation of C++ method CPPName.

Use the Description property to modify the description in the MethodDefinition object.

DetailedDescription — Doxygen @details comments

string scalar

Doxygen @details comments for the method from the header file, specified as a string scalar. If the C++ file does not contain a comment about the method, then DetailedDescription is empty and does not appear in the definition file.

If DetailedDescription is not empty, then the MATLAB doc command displays the following sentence before displaying the value of DetailedDescription:

This content is from the external library documentation.

Use the DetailedDescription property to provide more information about the interface definition file.

Examples

Example 1

Version History

Introduced in R2026b