Skip to content
This repository was archived by the owner on Nov 25, 2018. It is now read-only.

Commit 57c1a07

Browse files
committed
Update readme with new syntax
1 parent 5451b1e commit 57c1a07

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

Readme.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,29 @@
22

33
# mlapp2classdef
44

5-
MLAPP2CLASSDEF prompts the user to select an App Designer GUI, packaged as an `*.mlapp` file, and converts the GUI's class definition from an XML file to a standalone `*.m` file. Alternatively, it is possible to pass into the function a full path to an `*.mlapp` file or a cell vector of paths for e.g. batch conversion.
5+
MLAPP2CLASSDEF converts an App Designer GUI's class definition, packaged as a `*.mlapp` file, from XML to a standalone `*.m` class definition.
66

77
The class definition for an App Designer GUI is embedded in an XML file located in a subfolder of the packaged `*.mlapp` file, which can be accessed like a `*.zip` file. MLAPP2CLASSDEF strips the XML header & footer and saves the class definition to a `*.m` file located in the same path as the `*.mlapp` file.
88

9+
## Syntax
10+
11+
`MLAPP2CLASSDEF()` prompts the user to select a single `*.mlapp` file for processing
12+
13+
`MLAPP2CLASSDEF(pathToMLapp)` processes the files specified by the user. `pathToMLapp` can be a string for a single file or a cell array of strings for multiple files. Filepaths should be absolute.
14+
15+
### Examples
16+
17+
# MATLAB prompts user for file to processe
18+
mlapp2classdef()
19+
20+
# Process single user specified file:
21+
myguipath = 'C:\myfolder\mygui.mlapp';
22+
mlapp2classdef(myguipath)
23+
24+
# Process multiple user specified files:
25+
myguipaths = {'C:\myfolder\mygui.mlapp', 'C:\myfolder\mygui2.mlapp'};
26+
mlapp2classdef(myguipaths)
27+
928
# Current Limitations
1029

1130
MLAPP2CLASSDEF assumes that the targeted `*.mlapp` file is a GUI created by MATLAB's App Designer. Other packaged apps are not explicitly supported.

0 commit comments

Comments
 (0)