Publish mmstudio/latest

micro-manager · Dec 14, 2023 · 1574bc7 · 1574bc7
1 parent 939c02d
commit 1574bc7
Show file tree

Hide file tree

Showing 11 changed files with 93 additions and 87 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -8,6 +8,12 @@ on:
     branches:
       - 'pages/**'
 
+concurrency:
+  # Prevent overlapping runs of this workflow, which would cause a race on the
+  # gh-pages branch.
+  group: publish-to-gh-pages
+  cancel-in-progress: false
+
 jobs:
   update-html:
     name: Update docs for project/version

diff --git a/deprecated-list.html b/deprecated-list.html
@@ -186,13 +186,13 @@ <h2 title="Contents">Contents</h2>
 </td>
 </tr>
 <tr class="altColor">
-<td class="colOne"><a href="org/micromanager/acquisition/ChannelSpec.html#channelGroup">org.micromanager.acquisition.ChannelSpec.channelGroup</a>
-<div class="block"><span class="deprecationComment">Use Builder and getters instead</span></div>
+<td class="colOne"><a href="org/micromanager/acquisition/SequenceSettings.html#channelGroup">org.micromanager.acquisition.SequenceSettings.channelGroup</a>
+<div class="block"><span class="deprecationComment">use Builder and channelGroup() instead</span></div>
 </td>
 </tr>
 <tr class="rowColor">
-<td class="colOne"><a href="org/micromanager/acquisition/SequenceSettings.html#channelGroup">org.micromanager.acquisition.SequenceSettings.channelGroup</a>
-<div class="block"><span class="deprecationComment">use Builder and channelGroup() instead</span></div>
+<td class="colOne"><a href="org/micromanager/acquisition/ChannelSpec.html#channelGroup">org.micromanager.acquisition.ChannelSpec.channelGroup</a>
+<div class="block"><span class="deprecationComment">Use Builder and getters instead</span></div>
 </td>
 </tr>
 <tr class="altColor">
@@ -407,14 +407,16 @@ <h2 title="Contents">Contents</h2>
 <td class="colOne"><a href="org/micromanager/PropertyMap.html#copy--">org.micromanager.PropertyMap.copy()</a></td>
 </tr>
 <tr class="altColor">
-<td class="colOne"><a href="org/micromanager/display/DisplaySettings.html#copy--">org.micromanager.display.DisplaySettings.copy()</a></td>
-</tr>
-<tr class="rowColor">
 <td class="colOne"><a href="org/micromanager/acquisition/SequenceSettings.html#copy--">org.micromanager.acquisition.SequenceSettings.copy()</a>
 <div class="block"><span class="deprecationComment">When used correctly, SequenceSettings are immutable.
      If you really need a copy, use copyBuilder().build();</span></div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colOne"><a href="org/micromanager/data/Coords.html#copy--">org.micromanager.data.Coords.copy()</a>
+<div class="block"><span class="deprecationComment">Use <a href="org/micromanager/data/Coords.html#copyBuilder--"><code>copyBuilder</code></a> instead</span></div>
+</td>
+</tr>
 <tr class="altColor">
 <td class="colOne"><a href="org/micromanager/data/Metadata.html#copy--">org.micromanager.data.Metadata.copy()</a>
 <div class="block"><span class="deprecationComment">Use the appropriate of the following:
@@ -429,9 +431,7 @@ <h2 title="Contents">Contents</h2>
 </td>
 </tr>
 <tr class="altColor">
-<td class="colOne"><a href="org/micromanager/data/Coords.html#copy--">org.micromanager.data.Coords.copy()</a>
-<div class="block"><span class="deprecationComment">Use <a href="org/micromanager/data/Coords.html#copyBuilder--"><code>copyBuilder</code></a> instead</span></div>
-</td>
+<td class="colOne"><a href="org/micromanager/display/DisplaySettings.html#copy--">org.micromanager.display.DisplaySettings.copy()</a></td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="org/micromanager/data/DataManager.html#createCoords-java.lang.String-">org.micromanager.data.DataManager.createCoords(String)</a>
@@ -722,13 +722,13 @@ <h2 title="Contents">Contents</h2>
 <td class="colOne"><a href="org/micromanager/PropertyMap.html#getPropertyMap-java.lang.String-">org.micromanager.PropertyMap.getPropertyMap(String)</a></td>
 </tr>
 <tr class="altColor">
-<td class="colOne"><a href="org/micromanager/display/DisplayManager.html#getPropertyMapBuilder--">org.micromanager.display.DisplayManager.getPropertyMapBuilder()</a>
-<div class="block"><span class="deprecationComment">Use <a href="org/micromanager/PropertyMaps.html#builder--"><code>PropertyMaps.builder()</code></a> instead</span></div>
+<td class="colOne"><a href="org/micromanager/data/DataManager.html#getPropertyMapBuilder--">org.micromanager.data.DataManager.getPropertyMapBuilder()</a>
+<div class="block"><span class="deprecationComment">Use PropertyMaps.builder() instead</span></div>
 </td>
 </tr>
 <tr class="rowColor">
-<td class="colOne"><a href="org/micromanager/data/DataManager.html#getPropertyMapBuilder--">org.micromanager.data.DataManager.getPropertyMapBuilder()</a>
-<div class="block"><span class="deprecationComment">Use PropertyMaps.builder() instead</span></div>
+<td class="colOne"><a href="org/micromanager/display/DisplayManager.html#getPropertyMapBuilder--">org.micromanager.display.DisplayManager.getPropertyMapBuilder()</a>
+<div class="block"><span class="deprecationComment">Use <a href="org/micromanager/PropertyMaps.html#builder--"><code>PropertyMaps.builder()</code></a> instead</span></div>
 </td>
 </tr>
 <tr class="altColor">

diff --git a/org/micromanager/class-use/PropertyMap.html b/org/micromanager/class-use/PropertyMap.html
@@ -140,29 +140,29 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
 </td>
 </tr>
 <tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
-<td class="colLast"><span class="typeNameLabel">PropertyMaps.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyMaps.html#emptyPropertyMap--">emptyPropertyMap</a></span>()</code>
-<div class="block">Return the empty property map.</div>
-</td>
-</tr>
-<tr class="rowColor">
 <td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PropertyManager.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyManager.html#emptyPropertyMap--">emptyPropertyMap</a></span>()</code>
 <div class="block">Returns an empty property map.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>static <a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
-<td class="colLast"><span class="typeNameLabel">PropertyMaps.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyMaps.html#fromJSON-java.lang.String-">fromJSON</a></span>(java.lang.String&nbsp;json)</code>
-<div class="block">Create a property map from its JSON-serialized form.</div>
+<td class="colLast"><span class="typeNameLabel">PropertyMaps.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyMaps.html#emptyPropertyMap--">emptyPropertyMap</a></span>()</code>
+<div class="block">Return the empty property map.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PropertyManager.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyManager.html#fromJSON-java.lang.String-">fromJSON</a></span>(java.lang.String&nbsp;json)</code>
 <div class="block">Creates a property map from its JSON-serialized form.</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static <a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
+<td class="colLast"><span class="typeNameLabel">PropertyMaps.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyMaps.html#fromJSON-java.lang.String-">fromJSON</a></span>(java.lang.String&nbsp;json)</code>
+<div class="block">Create a property map from its JSON-serialized form.</div>
+</td>
+</tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PropertyMap.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyMap.html#getPropertyMap-java.lang.String-">getPropertyMap</a></span>(java.lang.String&nbsp;key)</code>
@@ -175,14 +175,14 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
               <a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;aDefault)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
-<td class="colLast"><span class="typeNameLabel">PropertyMaps.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyMaps.html#loadJSON-java.io.File-">loadJSON</a></span>(java.io.File&nbsp;file)</code>
+<td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
+<td class="colLast"><span class="typeNameLabel">PropertyManager.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyManager.html#loadJSON-java.io.File-">loadJSON</a></span>(java.io.File&nbsp;file)</code>
 <div class="block">Create a property map from its JSON-serialized form stored in a file.</div>
 </td>
 </tr>
 <tr class="rowColor">
-<td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
-<td class="colLast"><span class="typeNameLabel">PropertyManager.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyManager.html#loadJSON-java.io.File-">loadJSON</a></span>(java.io.File&nbsp;file)</code>
+<td class="colFirst"><code>static <a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
+<td class="colLast"><span class="typeNameLabel">PropertyMaps.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyMaps.html#loadJSON-java.io.File-">loadJSON</a></span>(java.io.File&nbsp;file)</code>
 <div class="block">Create a property map from its JSON-serialized form stored in a file.</div>
 </td>
 </tr>
@@ -194,8 +194,8 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
-<td class="colLast"><span class="typeNameLabel">StagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/StagePosition.html#toPropertyMap--">toPropertyMap</a></span>()</code>
-<div class="block">Returns this StagePosition instance as a PropertyMap.</div>
+<td class="colLast"><span class="typeNameLabel">PositionList.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PositionList.html#toPropertyMap--">toPropertyMap</a></span>()</code>
+<div class="block">Creates a PropertyMap from this PositionList.</div>
 </td>
 </tr>
 <tr class="altColor">
@@ -206,8 +206,8 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
-<td class="colLast"><span class="typeNameLabel">PositionList.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PositionList.html#toPropertyMap--">toPropertyMap</a></span>()</code>
-<div class="block">Creates a PropertyMap from this PositionList.</div>
+<td class="colLast"><span class="typeNameLabel">StagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/StagePosition.html#toPropertyMap--">toPropertyMap</a></span>()</code>
+<div class="block">Returns this StagePosition instance as a PropertyMap.</div>
 </td>
 </tr>
 </tbody>
@@ -239,17 +239,17 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
 </tr>
 <tbody>
 <tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../org/micromanager/StagePosition.html" title="class in org.micromanager">StagePosition</a></code></td>
-<td class="colLast"><span class="typeNameLabel">StagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/StagePosition.html#fromPropertyMap-org.micromanager.PropertyMap-">fromPropertyMap</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;pmap)</code>
-<div class="block">Returns the given PrropertyMap as a StagePosition.</div>
-</td>
-</tr>
-<tr class="rowColor">
 <td class="colFirst"><code>static <a href="../../../org/micromanager/MultiStagePosition.html" title="class in org.micromanager">MultiStagePosition</a></code></td>
 <td class="colLast"><span class="typeNameLabel">MultiStagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/MultiStagePosition.html#fromPropertyMap-org.micromanager.PropertyMap-">fromPropertyMap</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;pmap)</code>
 <div class="block">Generates a multistagePosition from the given PropertyMap.</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static <a href="../../../org/micromanager/StagePosition.html" title="class in org.micromanager">StagePosition</a></code></td>
+<td class="colLast"><span class="typeNameLabel">StagePosition.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/StagePosition.html#fromPropertyMap-org.micromanager.PropertyMap-">fromPropertyMap</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;pmap)</code>
+<div class="block">Returns the given PrropertyMap as a StagePosition.</div>
+</td>
+</tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PropertyMap.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/PropertyMap.html#getPropertyMap-java.lang.String-org.micromanager.PropertyMap-">getPropertyMap</a></span>(java.lang.String&nbsp;key,
@@ -468,13 +468,13 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
 <tbody>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
-<td class="colLast"><span class="typeNameLabel">Overlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/Overlay.html#getConfiguration--">getConfiguration</a></span>()</code>
+<td class="colLast"><span class="typeNameLabel">AbstractOverlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/AbstractOverlay.html#getConfiguration--">getConfiguration</a></span>()</code>
 <div class="block">Return the user-customizable settings for this overlay.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a></code></td>
-<td class="colLast"><span class="typeNameLabel">AbstractOverlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/AbstractOverlay.html#getConfiguration--">getConfiguration</a></span>()</code>
+<td class="colLast"><span class="typeNameLabel">Overlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/Overlay.html#getConfiguration--">getConfiguration</a></span>()</code>
 <div class="block">Return the user-customizable settings for this overlay.</div>
 </td>
 </tr>
@@ -489,13 +489,13 @@ <h3>Uses of <a href="../../../org/micromanager/PropertyMap.html" title="interfac
 <tbody>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="typeNameLabel">Overlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/Overlay.html#setConfiguration-org.micromanager.PropertyMap-">setConfiguration</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;config)</code>
+<td class="colLast"><span class="typeNameLabel">AbstractOverlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/AbstractOverlay.html#setConfiguration-org.micromanager.PropertyMap-">setConfiguration</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;config)</code>
 <div class="block">Configure the overlay with the given parameters.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="typeNameLabel">AbstractOverlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/AbstractOverlay.html#setConfiguration-org.micromanager.PropertyMap-">setConfiguration</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;config)</code>
+<td class="colLast"><span class="typeNameLabel">Overlay.</span><code><span class="memberNameLink"><a href="../../../org/micromanager/display/overlay/Overlay.html#setConfiguration-org.micromanager.PropertyMap-">setConfiguration</a></span>(<a href="../../../org/micromanager/PropertyMap.html" title="interface in org.micromanager">PropertyMap</a>&nbsp;config)</code>
 <div class="block">Configure the overlay with the given parameters.</div>
 </td>
 </tr>