clibgen.MethodDefinition - Definition for MATLAB function corresponding to C++ class method - MATLAB (original) (raw)

Main Content

Namespace: clibgen

Definition for MATLAB function corresponding to C++ class method

Description

The clibgen.MethodDefinition class contains the MATLAB® definition for a member function defined in the header of a C++ class.

The clibgen.MethodDefinition class is a handle class.

Properties

expand all

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

Example: clib.cppSample.TestClass.charInput Method of C++ classTestClass.

Attributes:

Help text from C++ header file for the end user describing details about the method, 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 MATLABdoc command displays this sentence before displaying the value ofDetailedDescription.

This content is from the external library documentation.

Attributes:

C++ method signature, specified as a string or a character vector. MATLAB creates CPPSignature from the method definition in the header file.

Example: void TestClass::intInput(int * ptr,int len)

Attributes:

Class containing the method, specified as a clibgen.ClassDefinition object.

Attributes:

Method signature in MATLAB, specified as a string or a character vector. MATLAB creates this signature.

Attributes:

Indicate if method definition is complete, specified as true orfalse.

Attributes:

Preferred function name for member functions derived from templates if there are overload functions, specified as a string or a character vector.

Example: "clib.libname.task_int_"

Attributes:

Methods

Version History

Introduced in R2019a