Add test for luarocks and ldoc warnings

.github/workflows/test-config.yml

@@ -0,0 +1,48 @@
+name: Test Config
+
+on:
+  push:
+    branches: [ pts ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test-luarocks:
+    name: Test LuaRocks
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
+
+      - uses: leafo/gh-actions-lua@d84e7d61946edb679210088bc1378c099fde51fe # v9.1.0
+
+      - uses: leafo/gh-actions-luarocks@e65774a6386cb4f24e293dca7fc4ff89165b64c5 # v4.3.0
+
+      - name: Setup
+        run: |
+          luarocks install --only-deps du-mocks-scm-0.rockspec
+
+      - name: Verify LuaRocks config
+        run: luarocks make
+
+  test-ldoc:
+    name: Test LDoc
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
+
+      - uses: leafo/gh-actions-lua@d84e7d61946edb679210088bc1378c099fde51fe # v9.1.0
+
+      - uses: leafo/gh-actions-luarocks@e65774a6386cb4f24e293dca7fc4ff89165b64c5 # v4.3.0
+
+      - name: Setup
+        run: |
+          luarocks install --only-deps du-mocks-scm-0.rockspec
+          luarocks install ldoc
+
+      - name: Verify codex builds cleanly
+        run: ldoc . --fatalwarnings
+
+      - name: Verify PTS codex builds cleanly
+        run: ldoc -c config-pts.ld . --fatalwarnings

.github/workflows/test.yml

@@ -33,9 +33,6 @@ jobs:
           luarocks install luacov
           luarocks install luafilesystem
 
-      - name: Verify LuaRocks config
-        run: luarocks make
-
       - name: Test
         run: ./test/runTests.sh -o junit
 

src/dumocks/ControlUnit.lua

@@ -164,7 +164,7 @@ end
 
 --- Set up a timer with a given tag in a given period. This will start to trigger the 'onTimer' event with the
 -- corresponding tag as an argument, to help you identify what is ticking, and when.
--- @tparam string tag The tag of the timer, as a string, which will be used in the 'onTimer' event to identify this
+-- @tparam string tag1 The tag of the timer, as a string, which will be used in the 'onTimer' event to identify this
 -- particular timer.
 -- @tparam second period The period of the timer, in seconds. The time resolution is limited by the framerate here, so
 -- you cannot set arbitrarily fast timers.