Отобразите справку для MATLABInterface к библиотеке C++

Используйте следующие функции MATLAB^®, чтобы просмотреть информацию о членах интерфейса C++.

справка Просмотрите классы и функции в пакете. Когда вы публикуете интерфейс, можно добавить описательный текст. Для получения дополнительной информации смотрите, Публикуют Измененный текст Справки.
методы Метод просмотра называет для класса.
methods с опцией '-full' — подписи Метода просмотра.
methodsview Табличное представление сигнатур методов. Вы можете найти окно methodsview легче использовать в качестве справочника, потому что вы не должны просматривать Командное окно путем прокрутки, чтобы найти информацию.

Если вы создали интерфейс school в примере, Задают и Публикуют Интерфейс к Библиотеке C++ Только для заголовка, то можно использовать его в следующих примерах. Принятие файла schoolInterface.dll находится в текущей папке, введите:

addpath('.')

Отобразите функции пакета и классы.

help clib.school

Classes contained in clib.school:
Person                         - clib.school.Person    Representation of C++ class Person
Teacher                        - clib.school.Teacher    Representation of C++ class Teacher
Student                        - clib.school.Student    Representation of C++ class Student

Functions contained in clib.school:
getName                        - clib.school.getName    Representation of C++ function getName

Чтобы отобразить вводы и выводы для функции пакета getName, щелкните по ссылке getName.

clib.school.getName    Representation of C++ function getName
  inputs
    p              clib.school.Person
  outputs
    RetVal         string

Чтобы отобразить методы класса, вызовите функцию methods для каждого класса. Например:

methods clib.school.Person

Methods for class clib.school.Person:

Person   eq       ge       getAge   getName  gt       le       lt       ne       setAge   setName  

Methods of clib.school.Person inherited from handle.

Чтобы отобразить функциональные подписи, вызовите функцию methodsview для каждого класса. Например:

methodsview clib.school.Person

Функция открывает окно, которое отображает методы и информацию об аргументах и возвращенных значениях. Например, подписи для конструкторов:

Возвратите тип	Имя	Аргументы
`clib.school.Person obj`	`Person`
`clib.school.Person obj`	`Person`	`Имя, скалярный возраст uint64)`
`clib.school.Person obj`	`Person`	`(clib.school.Person input1)`

Опубликуйте измененный текст справки

Когда вы публикуете интерфейс, функция clibgen.generateLibraryDefinition вставляет текст по умолчанию о классах и функциях. Функция help отображает этот текст пользователю. Можно изменить текст путем редактирования файла определения.

Примечание

Если вы уже загрузили пакет clib, например, вызвав help или вызвав конструктора класса, то необходимо перезапустить MATLAB, чтобы изменить интерфейс.

Например, справкой для класса Person является Representation of C++ class Person.

help clib.school

Classes contained in clib.school:
Person                         - clib.school.Person    Representation of C++ class Person
Teacher                        - clib.school.Teacher    Representation of C++ class Teacher
Student                        - clib.school.Student    Representation of C++ class Student

Чтобы изменить этот текст, отредактируйте defineschool.mlx. Ищите текст Representation of C++ class Person.

Измените значение "Description". Изменение:

"clib.school.Person    Representation of C++ class Person"

к:

"clib.school.Person    Class defined by name and age"

Сохраните файл.

Чтобы восстановить библиотеку, перезапустите MATLAB. Перейдите к папке, содержащей defineschool.mlx.

delete school\*.dll
build(defineschool)
addpath school
clib.school.Person
help clib.school

Classes contained in clib.school:
Person                         - clib.school.Person    Class defined by name and age
Teacher                        - clib.school.Teacher    Representation of C++ class Teacher
Student                        - clib.school.Student    Representation of C++ class Student

Документация