Merge pull request #1278 from rvilarl/docUpdate

documentation update

docs/api/classes/Articulation.html

@@ -157,7 +157,7 @@
 shift reverse.</p>
 </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>x: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Articulation.html" class="tsd-signature-type" data-tsd-kind="Class">Articulation</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setYShift" class="tsd-anchor"></a><h3>setYShift</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">setYShift<span class="tsd-signature-symbol">(</span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Articulation.html" class="tsd-signature-type" data-tsd-kind="Class">Articulation</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Modifier.html">Modifier</a>.<a href="Modifier.html#setYShift">setYShift</a></p></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Shift modifier down <code>y</code> pixels. Negative values shift up.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>y: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Articulation.html" class="tsd-signature-type" data-tsd-kind="Class">Articulation</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="easyScoreHook" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> easy<wbr/>Score<wbr/>Hook</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">easy<wbr/>Score<wbr/>Hook<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>articulations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span>, note<span class="tsd-signature-symbol">: </span><a href="StaveNote.html" class="tsd-signature-type" data-tsd-kind="Class">StaveNote</a>, builder<span class="tsd-signature-symbol">: </span><a href="Builder.html" class="tsd-signature-type" data-tsd-kind="Class">Builder</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>articulations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>articulations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li><h5>note: <a href="StaveNote.html" class="tsd-signature-type" data-tsd-kind="Class">StaveNote</a></h5></li><li><h5>builder: <a href="Builder.html" class="tsd-signature-type" data-tsd-kind="Class">Builder</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="format" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> format</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">(</span>articulations<span class="tsd-signature-symbol">: </span><a href="Articulation.html" class="tsd-signature-type" data-tsd-kind="Class">Articulation</a><span class="tsd-signature-symbol">[]</span>, state<span class="tsd-signature-symbol">: </span><a href="../interfaces/ModifierContextState.html" class="tsd-signature-type" data-tsd-kind="Interface">ModifierContextState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>y: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Articulation.html" class="tsd-signature-type" data-tsd-kind="Class">Articulation</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="easyScoreHook" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> easy<wbr/>Score<wbr/>Hook</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">easy<wbr/>Score<wbr/>Hook<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>articulations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span>, note<span class="tsd-signature-symbol">: </span><a href="StemmableNote.html" class="tsd-signature-type" data-tsd-kind="Class">StemmableNote</a>, builder<span class="tsd-signature-symbol">: </span><a href="Builder.html" class="tsd-signature-type" data-tsd-kind="Class">Builder</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>articulations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>articulations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li><h5>note: <a href="StemmableNote.html" class="tsd-signature-type" data-tsd-kind="Class">StemmableNote</a></h5></li><li><h5>builder: <a href="Builder.html" class="tsd-signature-type" data-tsd-kind="Class">Builder</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="format" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> format</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">(</span>articulations<span class="tsd-signature-symbol">: </span><a href="Articulation.html" class="tsd-signature-type" data-tsd-kind="Class">Articulation</a><span class="tsd-signature-symbol">[]</span>, state<span class="tsd-signature-symbol">: </span><a href="../interfaces/ModifierContextState.html" class="tsd-signature-type" data-tsd-kind="Interface">ModifierContextState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
 <p>FIXME:
 Most of the complex formatting logic (ie: snapping to space) is
 actually done in .render(). But that logic belongs in this method.</p>