Skip to content

Commit

Permalink
Dev: use it without adding
Browse files Browse the repository at this point in the history
  • Loading branch information
Pavel Roslovets committed Jul 12, 2019
1 parent e2b5550 commit a99a35a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions doc/ToolboxDev.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,12 @@
</span></a><a href = "#H_33B4449C"><span>Additional information
</span></a><span> </span><a href = "#H_D2922528"><span>Documentation
</span></a><span> </span><a href = "#H_51C11EE9"><span>App icon
</span></a><a href = "#H_9DCEB06E"><span>Examples</span></a></div></div><h2 class = 'S5' id = 'H_AB30FFB3' ><span>How to add</span></h2><div class = 'S1'><span>To add Dev class to current project folder execute</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S6'><span style="white-space: pre;"><span>ToolboxExtender.add(</span><span style="color: rgb(160, 32, 240);">'dev'</span><span>)</span></span></div></div></div><div class = 'S7'><span> </span></div><h2 class = 'S5' id = 'H_9164FF1D' ><span>Properties</span></h2><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>ext</span><span> - </span><a href = "matlab:ToolboxExtender.help('ToolboxExtender')"><span>ToolboxExtender</span></a><span> object</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>vp</span><span> - toolbox project version (from project file), </span><span style=' font-family: monospace;'>char</span></div><div class = 'S1'><span style=' font-family: monospace;'> </span></div><h2 class = 'S8' id = 'H_CC44416F' ><span>Methods</span></h2><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>dev = ToolboxDev(</span><span style=' font-weight: bold; font-style: italic; font-family: monospace;'>[extender]</span><span style=' font-weight: bold; font-family: monospace;'>)</span></div><div class = 'S1'><span>Create </span><span style=' font-style: italic; font-family: monospace;'>dev</span><span> object of </span><span style=' font-style: italic; font-family: monospace;'>ToolboxDev</span><span> class.</span></div><div class = 'S1'><span>If you call </span><span style=' font-style: italic; font-family: monospace;'>ToolboxDev</span><span> class with optional ToolboxExtender object </span><span style=' font-style: italic; font-family: monospace;'>extender</span><span>, </span><span style=' font-style: italic; font-family: monospace;'>dev</span><span> will use this object, otherwise new ToolboxExtender object will be created inside </span><span style=' font-style: italic; font-family: monospace;'>dev</span><span> (</span><span style=' font-style: italic; font-family: monospace;'>ext</span><span> property).</span></div><div class = 'S1'><span>If you call </span><span style=' font-style: italic; font-family: monospace;'>ToolboxDev</span><span> class with optional path to folder (</span><span style=' font-style: italic; font-family: monospace;'>extender</span><span style=' font-family: monospace;'> </span><span>argument</span><span style=' font-family: monospace;'>)</span><span>, new ToolboxExtender object will be created inside </span><span style=' font-style: italic; font-family: monospace;'>dev</span><span> (</span><span style=' font-style: italic; font-family: monospace;'>ext</span><span> property) for </span><span style=' font-style: italic; font-family: monospace;'>extender</span><span> path.</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>vp = gvp()</span></div><div class = 'S1'><span>Get project version</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>build(</span><span style=' font-weight: bold; font-style: italic; font-family: monospace;'>[version]</span><span style=' font-weight: bold; font-family: monospace;'>)</span></div><div class = 'S1'><span>Build binary installation file for destribution (</span><span style=' font-style: italic;'>.mltbx</span><span> or </span><span style=' font-style: italic;'>.mlappinstall</span><span>) for current version or for </span><span style=' font-style: italic;'>version</span><span> (optional) specified.</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>test(</span><span style=' font-weight: bold; font-style: italic; font-family: monospace;'>[version]</span><span style=' font-weight: bold; font-family: monospace;'>)</span></div><div class = 'S1'><span>Build and install current or specified </span><span style=' font-style: italic;'>version</span><span>. Version setting can be useful when you test the </span><span style=' font-style: italic; font-family: monospace;'>Updater</span><span> class.</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>gendoc()</span></div><div class = 'S1'><span>Generate html documentation from .mlx-files stored in </span><span style=' font-style: italic;'>doc</span><span> folder. Use this method if you want to test documentation without toolbox building.</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>release(</span><span style=' font-weight: bold; font-style: italic; font-family: monospace;'>[version]</span><span style=' font-weight: bold; font-family: monospace;'>)</span></div><div class = 'S1'><span>Release current or specified </span><span style=' font-style: italic;'>version</span><span> (optional) of toolbox. This method automatically perform:</span></div><ol class = 'S9'><li class = 'S10'><span>Generate </span><span style=' font-style: italic;'>.html</span><span> files from </span><span style=' font-style: italic;'>.mlx</span><span> in </span><span style=' font-style: italic;'>doc</span><span> folder</span></li><li class = 'S10'><span>Fix app icon (if app is included in project)</span></li><li class = 'S10'><span>Build installation file (see </span><span style=' font-family: monospace;'>build()</span><span>)</span></li><li class = 'S10'><span>Commit and push project to remote (GitHub)</span></li><li class = 'S10'><span>Tag the new one commit on GitHub by current version</span></li><li class = 'S10'><span>Copy installation file path to clipboard</span></li><li class = 'S10'><span>Open in web browser GitHub release page to help your create a new release of your toolbox (</span><span style=' font-weight: bold;'>don't forget</span><span> to attach binary installation file from your clipboard!)</span></li></ol><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>check()</span></div><div class = 'S1'><span>Check that latest release is valid and suitable for the </span><span style=' font-family: monospace;'>ToolboxUpdater</span><span> routine</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>webrel()</span></div><div class = 'S1'><span>Open release page on GitHub</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>webinstaller()</span></div><div class = 'S1'><span>Get MATLAB command to install toolbox directly from web (read about </span><a href = "matlab:ToolboxExtender.help('Installers')"><span>installers</span></a><span>)</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>untag(version)</span></div><div class = 'S1'><span>Delete specified by </span><span style=' font-style: italic;'>version</span><span> tag from GitHub. Use it in to delete fault release from remote</span></div><div class = 'S1'><span> </span></div><h2 class = 'S5' id = 'H_33B4449C' ><span>Additional information</span></h2><h3 class = 'S11' id = 'H_D2922528' ><span>Documentation</span></h3><div class = 'S1'><span>Store documentation as </span><span style=' font-style: italic;'>.mlx</span><span>-files in </span><span style=' font-style: italic;'>doc</span><span> folder. When </span><span style=' font-family: monospace;'>build()</span><span> or </span><span style=' font-family: monospace;'>release()</span><span> its will be automatically converted to </span><span style=' font-style: italic;'>.html</span></div><h3 class = 'S11' id = 'H_51C11EE9' ><span>App icon</span></h3><div class = 'S1'><span>If your toolbox suppose any App Designer app you may wish to add icon to it (against MATLAB bug). Just add icons for your app (</span><span style=' font-style: italic;'>icon_16.png</span><span> and </span><span style=' font-style: italic;'>icon_24.png</span><span>) to </span><span style=' font-style: italic;'>resources</span><span> folder</span></div><div class = 'S1'><span> </span></div><h2 class = 'S5' id = 'H_9DCEB06E' ><span>Examples</span></h2><div class = 'S1'><span>Create an object of the ToolboxDev</span></div><div class="CodeBlock"><div class="inlineWrapper outputs"><div class = 'S12'><span style="white-space: pre;"><span>dev_on</span></span></div><div class = 'S13'><div class="inlineElement eoOutputWrapper embeddedOutputsVariableStringElement" uid="45136099" data-testid="output_0" data-width="430" data-height="78" data-hashorizontaloverflow="false" style="width: 460px; max-height: 261px;"><div class="textElement"><div><span class="variableNameElement">dev = </span></div><div> ToolboxDev with properties:
</span></a><a href = "#H_D0667DCC"><span>Use ToolboxDev without adding
</span></a><a href = "#H_9DCEB06E"><span>Examples</span></a></div></div><h2 class = 'S5' id = 'H_AB30FFB3' ><span>How to add</span></h2><div class = 'S1'><span>To add Dev class to current project folder execute</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S6'><span style="white-space: pre;"><span>ToolboxExtender.add(</span><span style="color: rgb(160, 32, 240);">'dev'</span><span>)</span></span></div></div></div><div class = 'S7'><span> </span></div><h2 class = 'S5' id = 'H_9164FF1D' ><span>Properties</span></h2><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>ext</span><span> - </span><a href = "matlab:ToolboxExtender.help('ToolboxExtender')"><span>ToolboxExtender</span></a><span> object</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>vp</span><span> - toolbox project version (from project file), </span><span style=' font-family: monospace;'>char</span></div><div class = 'S1'><span style=' font-family: monospace;'> </span></div><h2 class = 'S8' id = 'H_CC44416F' ><span>Methods</span></h2><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>dev = ToolboxDev(</span><span style=' font-weight: bold; font-style: italic; font-family: monospace;'>[extender]</span><span style=' font-weight: bold; font-family: monospace;'>)</span></div><div class = 'S1'><span>Create </span><span style=' font-style: italic; font-family: monospace;'>dev</span><span> object of </span><span style=' font-style: italic; font-family: monospace;'>ToolboxDev</span><span> class.</span></div><div class = 'S1'><span>If you call </span><span style=' font-style: italic; font-family: monospace;'>ToolboxDev</span><span> class with optional ToolboxExtender object </span><span style=' font-style: italic; font-family: monospace;'>extender</span><span>, </span><span style=' font-style: italic; font-family: monospace;'>dev</span><span> will use this object, otherwise new ToolboxExtender object will be created inside </span><span style=' font-style: italic; font-family: monospace;'>dev</span><span> (</span><span style=' font-style: italic; font-family: monospace;'>ext</span><span> property).</span></div><div class = 'S1'><span>If you call </span><span style=' font-style: italic; font-family: monospace;'>ToolboxDev</span><span> class with optional path to folder (</span><span style=' font-style: italic; font-family: monospace;'>extender</span><span style=' font-family: monospace;'> </span><span>argument</span><span style=' font-family: monospace;'>)</span><span>, new ToolboxExtender object will be created inside </span><span style=' font-style: italic; font-family: monospace;'>dev</span><span> (</span><span style=' font-style: italic; font-family: monospace;'>ext</span><span> property) for </span><span style=' font-style: italic; font-family: monospace;'>extender</span><span> path.</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>vp = gvp()</span></div><div class = 'S1'><span>Get project version</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>build(</span><span style=' font-weight: bold; font-style: italic; font-family: monospace;'>[version]</span><span style=' font-weight: bold; font-family: monospace;'>)</span></div><div class = 'S1'><span>Build binary installation file for destribution (</span><span style=' font-style: italic;'>.mltbx</span><span> or </span><span style=' font-style: italic;'>.mlappinstall</span><span>) for current version or for </span><span style=' font-style: italic;'>version</span><span> (optional) specified.</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>test(</span><span style=' font-weight: bold; font-style: italic; font-family: monospace;'>[version]</span><span style=' font-weight: bold; font-family: monospace;'>)</span></div><div class = 'S1'><span>Build and install current or specified </span><span style=' font-style: italic;'>version</span><span>. Version setting can be useful when you test the </span><span style=' font-style: italic; font-family: monospace;'>Updater</span><span> class.</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>gendoc()</span></div><div class = 'S1'><span>Generate html documentation from .mlx-files stored in </span><span style=' font-style: italic;'>doc</span><span> folder. Use this method if you want to test documentation without toolbox building.</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>release(</span><span style=' font-weight: bold; font-style: italic; font-family: monospace;'>[version]</span><span style=' font-weight: bold; font-family: monospace;'>)</span></div><div class = 'S1'><span>Release current or specified </span><span style=' font-style: italic;'>version</span><span> (optional) of toolbox. This method automatically perform:</span></div><ol class = 'S9'><li class = 'S10'><span>Generate </span><span style=' font-style: italic;'>.html</span><span> files from </span><span style=' font-style: italic;'>.mlx</span><span> in </span><span style=' font-style: italic;'>doc</span><span> folder</span></li><li class = 'S10'><span>Fix app icon (if app is included in project)</span></li><li class = 'S10'><span>Build installation file (see </span><span style=' font-family: monospace;'>build()</span><span>)</span></li><li class = 'S10'><span>Commit and push project to remote (GitHub)</span></li><li class = 'S10'><span>Tag the new one commit on GitHub by current version</span></li><li class = 'S10'><span>Copy installation file path to clipboard</span></li><li class = 'S10'><span>Open in web browser GitHub release page to help your create a new release of your toolbox (</span><span style=' font-weight: bold;'>don't forget</span><span> to attach binary installation file from your clipboard!)</span></li></ol><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>check()</span></div><div class = 'S1'><span>Check that latest release is valid and suitable for the </span><span style=' font-family: monospace;'>ToolboxUpdater</span><span> routine</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>webrel()</span></div><div class = 'S1'><span>Open release page on GitHub</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>webinstaller()</span></div><div class = 'S1'><span>Get MATLAB command to install toolbox directly from web (read about </span><a href = "matlab:ToolboxExtender.help('Installers')"><span>installers</span></a><span>)</span></div><div class = 'S1'><span style=' font-weight: bold; font-family: monospace;'>untag(version)</span></div><div class = 'S1'><span>Delete specified by </span><span style=' font-style: italic;'>version</span><span> tag from GitHub. Use it in to delete fault release from remote</span></div><div class = 'S1'><span> </span></div><h2 class = 'S5' id = 'H_33B4449C' ><span>Additional information</span></h2><h3 class = 'S11' id = 'H_D2922528' ><span>Documentation</span></h3><div class = 'S1'><span>Store documentation as </span><span style=' font-style: italic;'>.mlx</span><span>-files in </span><span style=' font-style: italic;'>doc</span><span> folder. When </span><span style=' font-family: monospace;'>build()</span><span> or </span><span style=' font-family: monospace;'>release()</span><span> its will be automatically converted to </span><span style=' font-style: italic;'>.html</span></div><h3 class = 'S11' id = 'H_51C11EE9' ><span>App icon</span></h3><div class = 'S1'><span>If your toolbox suppose any App Designer app you may wish to add icon to it (against MATLAB bug). Just add icons for your app (</span><span style=' font-style: italic;'>icon_16.png</span><span> and </span><span style=' font-style: italic;'>icon_24.png</span><span>) to </span><span style=' font-style: italic;'>resources</span><span> folder</span></div><div class = 'S1'><span> </span></div><h2 class = 'S5' id = 'H_D0667DCC' ><span>Use ToolboxDev without adding</span></h2><div class = 'S1' id = 'H_96F18C35' ><span>If you want to use ToolboxDev without toolbox or just for Git-functionality (for project, package, etc) you can do it without adding ToolboxDev class to current folder.</span></div><div class = 'S1'><span>To do it execute:</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S6'><span style="white-space: pre;"><span>dev = ToolboxDev(pwd)</span></span></div></div></div><div class = 'S7'><span> </span></div><h2 class = 'S5' id = 'H_9DCEB06E' ><span>Examples</span></h2><div class = 'S1'><span>Create an object of the ToolboxDev</span></div><div class="CodeBlock"><div class="inlineWrapper outputs"><div class = 'S12'><span style="white-space: pre;"><span>dev_on</span></span></div><div class = 'S13'><div class="inlineElement eoOutputWrapper embeddedOutputsVariableStringElement" uid="F963D86B" data-testid="output_0" data-width="430" data-height="78" data-hashorizontaloverflow="false" style="width: 460px; max-height: 261px;"><div class="textElement"><div><span class="variableNameElement">dev = </span></div><div> ToolboxDev with properties:

TE: [1×1 ToolboxExtender]
vp: '1.0'
</div></div></div></div></div></div><div class = 'S7'><span>OR</span></div><div class="CodeBlock"><div class="inlineWrapper outputs"><div class = 'S12'><span style="white-space: pre;"><span>dev = ToolboxDev</span></span></div><div class = 'S13'><div class="inlineElement eoOutputWrapper embeddedOutputsVariableStringElement" uid="14886A7F" data-testid="output_1" data-width="430" data-height="78" data-hashorizontaloverflow="false" style="width: 460px; max-height: 261px;"><div class="textElement"><div><span class="variableNameElement">dev = </span></div><div> ToolboxDev with properties:
</div></div></div></div></div></div><div class = 'S7'><span>OR</span></div><div class="CodeBlock"><div class="inlineWrapper outputs"><div class = 'S12'><span style="white-space: pre;"><span>dev = ToolboxDev</span></span></div><div class = 'S13'><div class="inlineElement eoOutputWrapper embeddedOutputsVariableStringElement" uid="FD7DFA63" data-testid="output_1" data-width="430" data-height="78" data-hashorizontaloverflow="false" style="width: 460px; max-height: 261px;"><div class="textElement"><div><span class="variableNameElement">dev = </span></div><div> ToolboxDev with properties:

TE: [1×1 ToolboxExtender]
vp: '1.0'
Expand Down Expand Up @@ -141,6 +142,15 @@
% (against MATLAB bug). Just add icons for your app (_icon_16.png_ and _icon_24.png_)
% to _resources_ folder
%
% %% Use ToolboxDev without adding
% If you want to use ToolboxDev without toolbox or just for Git-functionality
% (for project, package, etc) you can do it without adding ToolboxDev class to
% current folder.
%
% To do it execute:
dev = ToolboxDev(pwd)
%%
% %% Examples
% Create an object of the ToolboxDev
Expand Down
Binary file modified doc/ToolboxDev.mlx
Binary file not shown.

0 comments on commit a99a35a

Please sign in to comment.