Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

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

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
builddocsearchdb Build searchable documentation database

Topics

Toolbox Files

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.

Manage Java Class Path for Toolboxes

Add or instruct users to add files to the Java® class path when they install a toolbox.

Documentation

Add Help for Your Program

Help text appears in the Command Window when you use the help function. Create help text for your program by inserting comments at the beginning.

Create Help for Classes

When you use the doc command to display help for a class, MATLAB automatically displays information that it derives from the class definition.

Check Which Programs Have Help

To determine which of your programs files have help text, you can generate a Help Report.

Create Help Summary Files — Contents.m

A Contents.m file contains comment lines that summarize the programs in a particular folder. The help, doc, and ver functions use this file to display information about folders.

Display Custom Documentation

If you create a toolbox that works with MathWorks® products, you can include custom documentation that is viewable in the MATLAB Help browser. Custom documentation can include figures, diagrams, screen captures, equations, and formatting to make your toolbox help more usable.

Display Custom Examples

Display examples such as videos, published program scripts, or other files that illustrate the use of your programs in the MATLAB help browser.

Was this topic helpful?