Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Spoons GitHub Bot authored and Spoons GitHub Bot committed Aug 7, 2024
1 parent e953c21 commit ad65c7d
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 46 deletions.
14 changes: 7 additions & 7 deletions docs/MouseFollowsFocus.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ <h5><a href="#logger">logger</a></h5>
</tr>
<tr>
<th>Source</th>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L21">Source/MouseFollowsFocus.spoon/init.lua line 21</a></td>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L24">Source/MouseFollowsFocus.spoon/init.lua line 24</a></td>
</tr>
</table>
</section>
Expand All @@ -76,13 +76,13 @@ <h5><a href="#configure">configure</a></h5>
</tr>
<tr>
<th>Description</th>
<td><p>Configures the spoon. There is currently nothing to configure.</p>
<td><p>Configures the spoon.</p>
</td>
</tr>
<tr>
<th>Parameters</th>
<td><ul>
<li>configuration - :</li>
<li>configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:</li>
</ul>
</td>
</tr>
Expand All @@ -92,7 +92,7 @@ <h5><a href="#configure">configure</a></h5>
</tr>
<tr>
<th>Source</th>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L26">Source/MouseFollowsFocus.spoon/init.lua line 26</a></td>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L29">Source/MouseFollowsFocus.spoon/init.lua line 29</a></td>
</tr>
</table>
</section>
Expand Down Expand Up @@ -126,7 +126,7 @@ <h5><a href="#start">start</a></h5>
</tr>
<tr>
<th>Source</th>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L35">Source/MouseFollowsFocus.spoon/init.lua line 35</a></td>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L44">Source/MouseFollowsFocus.spoon/init.lua line 44</a></td>
</tr>
</table>
</section>
Expand Down Expand Up @@ -160,7 +160,7 @@ <h5><a href="#stop">stop</a></h5>
</tr>
<tr>
<th>Source</th>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L61">Source/MouseFollowsFocus.spoon/init.lua line 61</a></td>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L73">Source/MouseFollowsFocus.spoon/init.lua line 73</a></td>
</tr>
</table>
</section>
Expand Down Expand Up @@ -194,7 +194,7 @@ <h5><a href="#updateMouse">updateMouse</a></h5>
</tr>
<tr>
<th>Source</th>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L72">Source/MouseFollowsFocus.spoon/init.lua line 72</a></td>
<td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/MouseFollowsFocus.spoon/init.lua#L84">Source/MouseFollowsFocus.spoon/init.lua line 84</a></td>
</tr>
</table>
</section>
Expand Down
32 changes: 16 additions & 16 deletions docs/docs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9663,15 +9663,15 @@
"Method": [
{
"def": "MouseFollowsFocus:configure(configuration)",
"desc": "Configures the spoon. There is currently nothing to configure.",
"doc": "Configures the spoon. There is currently nothing to configure.\n\nParameters:\n * configuration - :",
"desc": "Configures the spoon.",
"doc": "Configures the spoon.\n\nParameters:\n * configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "26",
"lineno": "29",
"name": "configure",
"notes": [],
"parameters": [
" * configuration - :"
" * configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:"
],
"returns": [],
"signature": "MouseFollowsFocus:configure(configuration)",
Expand All @@ -9684,7 +9684,7 @@
"doc": "Starts updating the mouse position when window focus changes\n\nParameters:\n * None",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "35",
"lineno": "44",
"name": "start",
"notes": [],
"parameters": [
Expand All @@ -9701,7 +9701,7 @@
"doc": "Stops updating the mouse position when window focus changes\n\nParameters:\n * None",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "61",
"lineno": "73",
"name": "stop",
"notes": [],
"parameters": [
Expand All @@ -9718,7 +9718,7 @@
"doc": "Moves the mouse to the center of the given window unless it's already inside the window\n\nParameters:\n * None",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "72",
"lineno": "84",
"name": "updateMouse",
"notes": [],
"parameters": [
Expand All @@ -9736,7 +9736,7 @@
"desc": "Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.",
"doc": "Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.",
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "21",
"lineno": "24",
"name": "logger",
"signature": "MouseFollowsFocus.logger",
"stripped_doc": "",
Expand All @@ -9748,15 +9748,15 @@
"items": [
{
"def": "MouseFollowsFocus:configure(configuration)",
"desc": "Configures the spoon. There is currently nothing to configure.",
"doc": "Configures the spoon. There is currently nothing to configure.\n\nParameters:\n * configuration - :",
"desc": "Configures the spoon.",
"doc": "Configures the spoon.\n\nParameters:\n * configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "26",
"lineno": "29",
"name": "configure",
"notes": [],
"parameters": [
" * configuration - :"
" * configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:"
],
"returns": [],
"signature": "MouseFollowsFocus:configure(configuration)",
Expand All @@ -9768,7 +9768,7 @@
"desc": "Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.",
"doc": "Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.",
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "21",
"lineno": "24",
"name": "logger",
"signature": "MouseFollowsFocus.logger",
"stripped_doc": "",
Expand All @@ -9780,7 +9780,7 @@
"doc": "Starts updating the mouse position when window focus changes\n\nParameters:\n * None",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "35",
"lineno": "44",
"name": "start",
"notes": [],
"parameters": [
Expand All @@ -9797,7 +9797,7 @@
"doc": "Stops updating the mouse position when window focus changes\n\nParameters:\n * None",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "61",
"lineno": "73",
"name": "stop",
"notes": [],
"parameters": [
Expand All @@ -9814,7 +9814,7 @@
"doc": "Moves the mouse to the center of the given window unless it's already inside the window\n\nParameters:\n * None",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "72",
"lineno": "84",
"name": "updateMouse",
"notes": [],
"parameters": [
Expand Down
2 changes: 1 addition & 1 deletion docs/docs_index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1834,7 +1834,7 @@
"type": "Variable"
},
{
"desc": "Configures the spoon. There is currently nothing to configure.",
"desc": "Configures the spoon.",
"module": "MouseFollowsFocus",
"name": "configure",
"type": "Method"
Expand Down
44 changes: 22 additions & 22 deletions docs/templated_docs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12318,20 +12318,20 @@
{
"def": "MouseFollowsFocus:configure(configuration)",
"def_gfm": "MouseFollowsFocus:configure(configuration)",
"desc": "Configures the spoon. There is currently nothing to configure.",
"desc_gfm": "<p>Configures the spoon. There is currently nothing to configure.</p>\n",
"doc": "Configures the spoon. There is currently nothing to configure.\n\nParameters:\n * configuration - :",
"doc_gfm": "<p>Configures the spoon. There is currently nothing to configure.</p>\n<p>Parameters:</p>\n<ul>\n<li>configuration - :</li>\n</ul>\n",
"desc": "Configures the spoon.",
"desc_gfm": "<p>Configures the spoon.</p>\n",
"doc": "Configures the spoon.\n\nParameters:\n * configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:",
"doc_gfm": "<p>Configures the spoon.</p>\n<p>Parameters:</p>\n<ul>\n<li>configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:</li>\n</ul>\n",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "26",
"lineno": "29",
"name": "configure",
"notes": [],
"notes_gfm": "",
"parameters": [
" * configuration - :"
" * configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:"
],
"parameters_gfm": "<ul>\n<li>configuration - :</li>\n</ul>\n",
"parameters_gfm": "<ul>\n<li>configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:</li>\n</ul>\n",
"returns": [],
"returns_gfm": "",
"signature": "MouseFollowsFocus:configure(configuration)",
Expand All @@ -12347,7 +12347,7 @@
"doc_gfm": "<p>Starts updating the mouse position when window focus changes</p>\n<p>Parameters:</p>\n<ul>\n<li>None</li>\n</ul>\n",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "35",
"lineno": "44",
"name": "start",
"notes": [],
"notes_gfm": "",
Expand All @@ -12370,7 +12370,7 @@
"doc_gfm": "<p>Stops updating the mouse position when window focus changes</p>\n<p>Parameters:</p>\n<ul>\n<li>None</li>\n</ul>\n",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "61",
"lineno": "73",
"name": "stop",
"notes": [],
"notes_gfm": "",
Expand All @@ -12393,7 +12393,7 @@
"doc_gfm": "<p>Moves the mouse to the center of the given window unless it's already inside the window</p>\n<p>Parameters:</p>\n<ul>\n<li>None</li>\n</ul>\n",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "72",
"lineno": "84",
"name": "updateMouse",
"notes": [],
"notes_gfm": "",
Expand All @@ -12417,7 +12417,7 @@
"doc": "Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.",
"doc_gfm": "<p>Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.</p>\n",
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "21",
"lineno": "24",
"name": "logger",
"signature": "MouseFollowsFocus.logger",
"stripped_doc": "",
Expand All @@ -12432,20 +12432,20 @@
{
"def": "MouseFollowsFocus:configure(configuration)",
"def_gfm": "MouseFollowsFocus:configure(configuration)",
"desc": "Configures the spoon. There is currently nothing to configure.",
"desc_gfm": "<p>Configures the spoon. There is currently nothing to configure.</p>\n",
"doc": "Configures the spoon. There is currently nothing to configure.\n\nParameters:\n * configuration - :",
"doc_gfm": "<p>Configures the spoon. There is currently nothing to configure.</p>\n<p>Parameters:</p>\n<ul>\n<li>configuration - :</li>\n</ul>\n",
"desc": "Configures the spoon.",
"desc_gfm": "<p>Configures the spoon.</p>\n",
"doc": "Configures the spoon.\n\nParameters:\n * configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:",
"doc_gfm": "<p>Configures the spoon.</p>\n<p>Parameters:</p>\n<ul>\n<li>configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:</li>\n</ul>\n",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "26",
"lineno": "29",
"name": "configure",
"notes": [],
"notes_gfm": "",
"parameters": [
" * configuration - :"
" * configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:"
],
"parameters_gfm": "<ul>\n<li>configuration - :</li>\n</ul>\n",
"parameters_gfm": "<ul>\n<li>configuration - a table containing the settings for onWindowMoved or onChangeOfScreenOnly:</li>\n</ul>\n",
"returns": [],
"returns_gfm": "",
"signature": "MouseFollowsFocus:configure(configuration)",
Expand All @@ -12460,7 +12460,7 @@
"doc": "Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.",
"doc_gfm": "<p>Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.</p>\n",
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "21",
"lineno": "24",
"name": "logger",
"signature": "MouseFollowsFocus.logger",
"stripped_doc": "",
Expand All @@ -12475,7 +12475,7 @@
"doc_gfm": "<p>Starts updating the mouse position when window focus changes</p>\n<p>Parameters:</p>\n<ul>\n<li>None</li>\n</ul>\n",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "35",
"lineno": "44",
"name": "start",
"notes": [],
"notes_gfm": "",
Expand All @@ -12498,7 +12498,7 @@
"doc_gfm": "<p>Stops updating the mouse position when window focus changes</p>\n<p>Parameters:</p>\n<ul>\n<li>None</li>\n</ul>\n",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "61",
"lineno": "73",
"name": "stop",
"notes": [],
"notes_gfm": "",
Expand All @@ -12521,7 +12521,7 @@
"doc_gfm": "<p>Moves the mouse to the center of the given window unless it's already inside the window</p>\n<p>Parameters:</p>\n<ul>\n<li>None</li>\n</ul>\n",
"examples": [],
"file": "Source/MouseFollowsFocus.spoon/init.lua",
"lineno": "72",
"lineno": "84",
"name": "updateMouse",
"notes": [],
"notes_gfm": "",
Expand Down

0 comments on commit ad65c7d

Please sign in to comment.