clibgen.FunctionDefinition - Definition for MATLAB function corresponding to C++ package function - MATLAB (original) (raw)

• Documentation
• Examples
• Functions
• Apps
• Videos
• Answers

Main Content

Namespace: clibgen

Definition for MATLAB function corresponding to C++ package function

Description

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

The clibgen.FunctionDefinition class is a handle class.

Properties

expand all

Description — Help text

string | character vector

Help text for the end user describing the package function, 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.charInput Representation of C++ functioncharInput.

Attributes:

DetailedDescription — Help text from C++ header file

string | character vector | empty string

Help text from C++ header file for the end user describing details about the package function, 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:

CPPSignature — C++ function signature

string | character vector

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

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

Attributes:

DefiningLibrary — Library containing function

clibgen.LibraryDefinition

Library containing the function, specified as a clibgen.LibraryDefinition object.

Attributes:

MATLABName — C++ function name in MATLAB

string | character vector

C++ function name in MATLAB, specified as a string or a character vector.

Attributes:

MATLABSignature — Function signature in MATLAB

string | character vector

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

Attributes:

Valid — Definition complete indicator

false (default) | true

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

Attributes:

TemplateUniqueName — Preferred function name

string | character vector

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

Example: "clib.libname.task_int_"

Attributes:

Version History

Introduced in R2019a