Browse Source

Fix a few docs issues;

bjorn 3 days ago
parent
commit
5346fec930
3 changed files with 19 additions and 4 deletions
  1. 2 1
      api/init.lua
  2. 6 1
      api/lovr/callbacks/quit.lua
  3. 11 2
      api/lovr/headset/update.lua

+ 2 - 1
api/init.lua

@@ -26459,7 +26459,8 @@ return {
           key = "lovr.headset.update",
           key = "lovr.headset.update",
           module = "lovr.headset",
           module = "lovr.headset",
           related = {
           related = {
-            "lovr.headset.submit"
+            "lovr.headset.submit",
+            "lovr.run"
           },
           },
           variants = {
           variants = {
             {
             {

+ 6 - 1
api/lovr/callbacks/quit.lua

@@ -5,7 +5,12 @@ return {
     This callback is called right before the application is about to quit.  Use it to perform any
     This callback is called right before the application is about to quit.  Use it to perform any
     necessary cleanup work.  A truthy value can be returned from this callback to abort quitting.
     necessary cleanup work.  A truthy value can be returned from this callback to abort quitting.
   ]],
   ]],
-  arguments = {},
+  arguments = {
+    code = {
+      type = 'number',
+      description = 'The exit code for the program (zero for success, non-zero for error).'
+    }
+  },
   returns = {
   returns = {
     abort = {
     abort = {
       type = 'boolean',
       type = 'boolean',

+ 11 - 2
api/lovr/headset/update.lua

@@ -7,7 +7,15 @@ return {
     of by the default `lovr.run` implementation.
     of by the default `lovr.run` implementation.
   ]],
   ]],
   arguments = {},
   arguments = {},
-  returns = {},
+  returns = {
+    dt = {
+      type = 'number',
+      description = [[
+        The delta time since the last frame.  This is the same value returned by
+        `lovr.headset.getDeltaTime`, and is used by boot.lua.
+      ]]
+    }
+  },
   variants = {
   variants = {
     {
     {
       arguments = {},
       arguments = {},
@@ -15,6 +23,7 @@ return {
     }
     }
   },
   },
   related = {
   related = {
-    'lovr.headset.submit'
+    'lovr.headset.submit',
+    'lovr.run'
   }
   }
 }
 }