Toolbox Distribution

Create and share toolboxes; add documentation

You can package MATLAB^® files to create a toolbox to share with others. These files can include MATLAB code, data, apps, examples, and documentation. When you create a toolbox, MATLAB generates a single installation file (.mltbx) that enables you or others to install your toolbox.

Functions

expand all

Toolbox Files

`matlab.addons.toolbox.packageToolbox`	Package toolbox project
`matlab.addons.toolbox.toolboxVersion`	Query or modify version of toolbox
`matlab.addons.toolbox.installToolbox`	Install toolbox file
`matlab.addons.toolbox.uninstallToolbox`	Uninstall toolbox
`matlab.addons.toolbox.installedToolboxes`	Return information about installed toolboxes
`matlab.addons.toolbox.ToolboxOptions`	Options for packaging toolbox project (Since R2023a)

Code Dependencies

matlab.codetools.requiredFilesAndProducts List dependencies of MATLAB program files

Documentation and Code Completions

`builddocsearchdb`	Build searchable documentation database
`patchdemoxmlfile`	Patch `demos.xml` file (Since R2021a)
`validateFunctionSignaturesJSON`	Validate `functionSignatures.json` files

Settings API

`matlab.settings.FactoryGroup.createToolboxGroup`	Create `FactoryGroup` root object for toolbox
`addGroup`	Add new factory settings group
`addSetting`	Add new factory setting
`matlab.settings.mustBeLogicalScalar`	Validate that setting value is a logical scalar
`matlab.settings.mustBeNumericScalar`	Validate that setting value is a numeric scalar
`matlab.settings.mustBeStringScalar`	Validate that setting value is a string scalar
`matlab.settings.mustBeIntegerScalar`	Validate that setting value is an integer scalar
`matlab.settings.SettingsFileUpgrader`	Version-specific changes in factory settings tree of toolbox
`move`	Record move or rename of factory setting or group
`remove`	Record removal of factory setting or group
`matlab.settings.reloadFactoryFile`	Load or reload factory settings
`matlab.settings.loadSettingsCompatibilityResults`	Results of upgrading personal settings of toolbox for specific version
`FactoryGroup`	Group of factory settings and factory subgroup objects
`FactorySetting`	Factory settings object
`ReleaseCompatibilityResults`	Results of upgrading toolbox with specific version number
`ReleaseCompatibilityException`	Exception that occurs when upgrading toolbox
`VersionResults`	Results of upgrade operations
`OperationResult`	Status of individual operation when upgrading toolbox

Topics

Create and Share Toolboxes
You can package MATLAB files to create a single installation file to share with others. These files can include MATLAB code, data, apps, examples, and documentation.
Identify Program Dependencies
Determine which functions and scripts your program is dependent upon.
Add Help for Your Program

Add help text to your program that displays in the Command Window when you use the help function.
- Create Help for Classes
- Create Help Summary Files — Contents.m
- Display Custom Documentation
- Display Custom Examples
Customize Code Suggestions and Completions
To customize code suggestions and completions for your functions, provide MATLAB with information about your function signatures.
Create Factory Settings for Toolboxes
Create factory settings that can be used to customize the appearance and behavior of the toolbox after installation.