bat365 Homepage

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

Protect Code

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

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.
Security Considerations to Protect Your Source Code

When you share your MATLAB code, the contents are easily accessed, revealing design and implementation details. You can obfuscate or compile your source files.
- Create a Content-Obscured File with P-Code
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.