瀏覽代碼

Formatting; Rebuild;

bjorn 3 年之前
父節點
當前提交
92902ac090
共有 3 個文件被更改,包括 548 次插入3127 次删除
  1. 522 3110
      api/init.lua
  2. 13 6
      api/lovr/headset/getDisplayFrequencies.lua
  3. 13 11
      api/lovr/headset/setDisplayFrequency.lua

File diff suppressed because it is too large
+ 522 - 3110
api/init.lua


+ 13 - 6
api/lovr/headset/getDisplayFrequencies.lua

@@ -1,13 +1,20 @@
 return {
-  tag = "headset",
-  summary = "Get the list of refresh rates supported by the headset display.",
-  description = "Returns a table with all the refresh rates supported by the headset display, in Hz.",
+  tag = 'headset',
+  summary = 'Get the list of refresh rates supported by the headset display.',
+  description = [[
+    Returns a table with all the refresh rates supported by the headset display, in Hz.
+  ]],
   arguments = {},
   returns = {
     {
-      name = "frequencies",
-      type = "table",
-      description = "A flat table of the refresh rates supported by the headset display, nil if not supported."
+      name = 'frequencies',
+      type = 'table',
+      description = [[
+        A flat table of the refresh rates supported by the headset display, nil if not supported.
+      ]]
     }
+  },
+  related = {
+    'lovr.headset.setDisplayFrequency'
   }
 }

+ 13 - 11
api/lovr/headset/setDisplayFrequency.lua

@@ -1,21 +1,23 @@
 return {
-  tag = "headset",
-  summary = "Set the display refresh rate.",
-  description = "Sets the display refresh rate, in Hz.",
-  module = "lovr.headset",
+  tag = 'headset',
+  summary = 'Set the display refresh rate.',
+  description = 'Sets the display refresh rate, in Hz.',
   arguments = {
     {
-      name = "frequency",
-      type = "number",
-      description = "The refresh rate to set, in Hz",
+      name = 'frequency',
+      type = 'number',
+      description = 'The new refresh rate, in Hz.',
     }
   },
   returns = {
     {
-      name = "success",
-      type = "boolean",
-      description = "Whether the display refresh rate was successfully set."
+      name = 'success',
+      type = 'boolean',
+      description = 'Whether the display refresh rate was successfully set.'
     }
   },
-  notes = "Changing the display refresh-rate also changes the frequency of lovr.update() and lovr.draw() as they depend on the display frequency."
+  notes = [[
+    Changing the display refresh-rate also changes the frequency of lovr.update() and lovr.draw() as
+    they depend on the display frequency.
+  ]]
 }

Some files were not shown because too many files changed in this diff