Передача тулбокса

Создание и совместное использование тулбоксов; добавить документацию

Вы можете упаковать MATLAB® файлы для создания тулбокса для совместного использования с другими пользователями. Эти файлы могут включать код MATLAB, данные, приложения, примеры и документацию. Когда вы создаете тулбокс, MATLAB генерирует один инсталляционный файл (.mltbx), что позволяет вам или другим установить тулбокс.

Функции

расширить все

matlab.addons.toolbox.packageToolboxУпаковать проект тулбокса
matlab.addons.toolbox.toolboxVersionЗапрос или изменение версии тулбокса
matlab.addons.toolbox.installToolboxУстановите файл тулбокса
matlab.addons.toolbox.uninstallToolboxUninstall тулбокса
matlab.addons.toolbox.installedToolboxesВозвращает информацию об установленных тулбоксах
builddocsearchdbСоздайте базу данных документации с возможностью поиска
patchdemoxmlfileЗакрашенная фигура- demos.xml файл
validateFunctionSignaturesJSONВалидация functionSignatures.json файлы
matlab.codetools.requiredFilesAndProductsСписок зависимостей программных файлов MATLAB
matlab.settings.FactoryGroup.createToolboxGroupСоздание FactoryGroup корневой объект для тулбокса
addGroupДобавить новую группу заводских параметров
addSettingДобавьте новые заводские настройки
matlab.settings.mustBeLogicalScalarПроверьте, что значение параметра является логическим скаляром
matlab.settings.mustBeNumericScalarПроверьте, что значение параметра является числовым скаляром
matlab.settings.mustBeStringScalarПроверьте, что значение параметра является строковым скаляром
matlab.settings.mustBeIntegerScalarПроверьте, что значение параметра является целочисленным скаляром
matlab.settings.SettingsFileUpgraderИзменения, относящиеся к версии, в дереве заводских настроек тулбокса
moveЗапись перемещения или переименования заводских настроек или группы
removeЗапись удаления заводских настроек или группы
matlab.settings.reloadFactoryFileЗагрузка или перезагрузка заводских настроек
matlab.settings.loadSettingsCompatibilityResultsРезультаты обновления личных настроек тулбокса для конкретной версии
FactoryGroupГруппа заводских настроек и объектов заводских подгрупповых объектов
FactorySettingОбъект заводских настроек
ReleaseCompatibilityResultsРезультаты обновления тулбокса с определенным номером версии
ReleaseCompatibilityExceptionИсключение, которое возникает при обновлении тулбокса
VersionResultsРезультаты операций обновления
OperationResultСостояние индивидуальной операции при обновлении тулбокса

Темы

Создание и совместное использование тулбоксов

Можно упаковать файлы MATLAB, чтобы создать один установочный файл для общего доступа к другим. Эти файлы могут включать код MATLAB, данные, приложения, примеры и документацию.

Добавьте справку для своей программы

Текст справки появляется в Командном окне, когда вы используете help функция. Создайте текст справки для программы, вставив комментарии в начале.

Проверьте, какие программы имеют помощь

Чтобы определить, какие из файлов программ имеют текст справки, можно сгенерировать отчет справки.

Настройка предложений и дополнений кода

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

Отображение пользовательской документации

Если вы создаете тулбокс, который работает с MathWorks® можно включать пользовательскую документацию, которая доступна для просмотра в браузере MATLAB Help. Пользовательская документация может включать рисунки, схемы, захваты экрана, уравнения и форматирование, чтобы сделать вашу помощь тулбокса более полезной.

Отображение пользовательских примеров

Отображать примеры, такие как видео, опубликованные скрипты программ или другие файлы, которые иллюстрируют использование ваших программ в браузере документации MATLAB.

Идентифицируйте Программные зависимости

Определите, от каких функций и скриптов зависит ваша программа.

Создание заводских настроек для тулбоксов

Создайте заводские настройки, которые могут использоваться для настройки внешнего вида и поведения тулбокса после установки.