Browse Source

Use markdown in descriptions;

bjorn 6 years ago
parent
commit
ad5f0004c7

+ 16 - 16
api/init.lua

@@ -946,7 +946,7 @@ return {
                 {
                 {
                   name = "microphone",
                   name = "microphone",
                   type = "Microphone",
                   type = "Microphone",
-                  description = "The new Microphone, or nil if the capture settings are not supported."
+                  description = "The new Microphone, or `nil` if the capture settings are not supported."
                 }
                 }
               }
               }
             }
             }
@@ -3557,7 +3557,7 @@ return {
                     {
                     {
                       name = "parent",
                       name = "parent",
                       type = "number",
                       type = "number",
-                      description = "The index of the node's parent, or nil if the node is the root node."
+                      description = "The index of the node's parent, or `nil` if the node is the root node."
                     }
                     }
                   }
                   }
                 }
                 }
@@ -7324,7 +7324,7 @@ return {
                 {
                 {
                   name = "canvas",
                   name = "canvas",
                   type = "Canvas",
                   type = "Canvas",
-                  description = "The active Canvas, or nil if no canvas is set."
+                  description = "The active Canvas, or `nil` if no canvas is set."
                 }
                 }
               }
               }
             }
             }
@@ -7559,7 +7559,7 @@ return {
                 {
                 {
                   name = "shader",
                   name = "shader",
                   type = "Shader",
                   type = "Shader",
-                  description = "The active shader object, or nil if none is active."
+                  description = "The active shader object, or `nil` if none is active."
                 }
                 }
               }
               }
             }
             }
@@ -9414,7 +9414,7 @@ return {
                 {
                 {
                   name = "canvas",
                   name = "canvas",
                   type = "Canvas",
                   type = "Canvas",
-                  description = "The new active Canvas object, or nil to just render to the headset."
+                  description = "The new active Canvas object, or `nil` to just render to the headset."
                 }
                 }
               },
               },
               returns = {}
               returns = {}
@@ -9537,7 +9537,7 @@ return {
                 {
                 {
                   name = "compareMode",
                   name = "compareMode",
                   type = "CompareMode",
                   type = "CompareMode",
-                  description = "The new depth test.  Use nil to disable the depth test.",
+                  description = "The new depth test.  Use `nil` to disable the depth test.",
                   default = "nil"
                   default = "nil"
                 },
                 },
                 {
                 {
@@ -9568,7 +9568,7 @@ return {
                 {
                 {
                   name = "font",
                   name = "font",
                   type = "Font",
                   type = "Font",
-                  description = "The font to use.  If nil, the default font is set.",
+                  description = "The font to use.  If `nil`, the default font is set.",
                   default = "nil"
                   default = "nil"
                 }
                 }
               },
               },
@@ -11454,7 +11454,7 @@ return {
                     {
                     {
                       name = "texture",
                       name = "texture",
                       type = "Texture",
                       type = "Texture",
-                      description = "The texture that is set, or nil if no texture is set."
+                      description = "The texture that is set, or `nil` if no texture is set."
                     }
                     }
                   }
                   }
                 }
                 }
@@ -11619,7 +11619,7 @@ return {
                     {
                     {
                       name = "texture",
                       name = "texture",
                       type = "Texture",
                       type = "Texture",
-                      description = "The texture to apply, or nil to use the default."
+                      description = "The texture to apply, or `nil` to use the default."
                     }
                     }
                   },
                   },
                   returns = {}
                   returns = {}
@@ -11629,7 +11629,7 @@ return {
                     {
                     {
                       name = "texture",
                       name = "texture",
                       type = "Texture",
                       type = "Texture",
-                      description = "The texture to apply, or nil to use the default."
+                      description = "The texture to apply, or `nil` to use the default."
                     }
                     }
                   },
                   },
                   returns = {}
                   returns = {}
@@ -12712,7 +12712,7 @@ return {
                     {
                     {
                       name = "animator",
                       name = "animator",
                       type = "Animator",
                       type = "Animator",
-                      description = "The Animator attached to the Model, or nil if none is set."
+                      description = "The Animator attached to the Model, or `nil` if none is set."
                     }
                     }
                   }
                   }
                 }
                 }
@@ -12970,7 +12970,7 @@ return {
                     {
                     {
                       name = "slice",
                       name = "slice",
                       type = "number",
                       type = "number",
-                      description = "The slice of a cube, array, or volume texture to use, or nil for all slices.",
+                      description = "The slice of a cube, array, or volume texture to use, or `nil` for all slices.",
                       default = "nil"
                       default = "nil"
                     },
                     },
                     {
                     {
@@ -13003,7 +13003,7 @@ return {
                     {
                     {
                       name = "slice",
                       name = "slice",
                       type = "number",
                       type = "number",
-                      description = "The slice of a cube, array, or volume texture to use, or nil for all slices.",
+                      description = "The slice of a cube, array, or volume texture to use, or `nil` for all slices.",
                       default = "nil"
                       default = "nil"
                     },
                     },
                     {
                     {
@@ -14685,7 +14685,7 @@ return {
                     {
                     {
                       name = "model",
                       name = "model",
                       type = "Model",
                       type = "Model",
-                      description = "The new Model, or nil if a model could not be loaded."
+                      description = "The new Model, or `nil` if a model could not be loaded."
                     }
                     }
                   }
                   }
                 }
                 }
@@ -20985,7 +20985,7 @@ return {
                     {
                     {
                       name = "message",
                       name = "message",
                       type = "*",
                       type = "*",
-                      description = "The received message, or nil if nothing was received."
+                      description = "The received message, or `nil` if nothing was received."
                     }
                     }
                   }
                   }
                 }
                 }
@@ -21061,7 +21061,7 @@ return {
                     {
                     {
                       name = "error",
                       name = "error",
                       type = "string",
                       type = "string",
-                      description = "The error message, or nil if no error has occurred on the Thread."
+                      description = "The error message, or `nil` if no error has occurred on the Thread."
                     }
                     }
                   }
                   }
                 }
                 }

+ 1 - 1
api/lovr/audio/newMicrophone.lua

@@ -42,7 +42,7 @@ return {
     {
     {
       name = 'microphone',
       name = 'microphone',
       type = 'Microphone',
       type = 'Microphone',
-      description = 'The new Microphone, or nil if the capture settings are not supported.'
+      description = 'The new Microphone, or `nil` if the capture settings are not supported.'
     }
     }
   },
   },
   related = {
   related = {

+ 1 - 1
api/lovr/data/ModelData/getNodeParent.lua

@@ -12,7 +12,7 @@ return {
     {
     {
       name = 'parent',
       name = 'parent',
       type = 'number',
       type = 'number',
-      description = 'The index of the node\'s parent, or nil if the node is the root node.'
+      description = 'The index of the node\'s parent, or `nil` if the node is the root node.'
     }
     }
   },
   },
   notes = 'An error will be thrown if an invalid node index is supplied.',
   notes = 'An error will be thrown if an invalid node index is supplied.',

+ 1 - 1
api/lovr/graphics/Material/getTexture.lua

@@ -16,7 +16,7 @@ return {
     {
     {
       name = 'texture',
       name = 'texture',
       type = 'Texture',
       type = 'Texture',
-      description = 'The texture that is set, or nil if no texture is set.'
+      description = 'The texture that is set, or `nil` if no texture is set.'
     }
     }
   },
   },
   related = {
   related = {

+ 1 - 1
api/lovr/graphics/Material/setTexture.lua

@@ -12,7 +12,7 @@ return {
     },
     },
     texture = {
     texture = {
       type = 'Texture',
       type = 'Texture',
-      description = 'The texture to apply, or nil to use the default.'
+      description = 'The texture to apply, or `nil` to use the default.'
     },
     },
     canvas = {
     canvas = {
       type = 'Canvas',
       type = 'Canvas',

+ 1 - 1
api/lovr/graphics/Mesh/getVertexMap.lua

@@ -17,7 +17,7 @@ return {
   returns = {
   returns = {
     map = {
     map = {
       type = 'table',
       type = 'table',
-      description = 'The list of indices in the vertex map, or nil if no vertex map is set.'
+      description = 'The list of indices in the vertex map, or `nil` if no vertex map is set.'
     }
     }
   },
   },
   variants = {
   variants = {

+ 1 - 1
api/lovr/graphics/Model/getAnimator.lua

@@ -9,7 +9,7 @@ return {
     {
     {
       name = 'animator',
       name = 'animator',
       type = 'Animator',
       type = 'Animator',
-      description = 'The Animator attached to the Model, or nil if none is set.'
+      description = 'The Animator attached to the Model, or `nil` if none is set.'
     }
     }
   },
   },
   related = {
   related = {

+ 1 - 1
api/lovr/graphics/Shader/sendImage.lua

@@ -18,7 +18,7 @@ return {
     slice = {
     slice = {
       type = 'number',
       type = 'number',
       default = 'nil',
       default = 'nil',
-      description = 'The slice of a cube, array, or volume texture to use, or nil for all slices.'
+      description = 'The slice of a cube, array, or volume texture to use, or `nil` for all slices.'
     },
     },
     mipmap = {
     mipmap = {
       type = 'number',
       type = 'number',

+ 1 - 1
api/lovr/graphics/getCanvas.lua

@@ -11,7 +11,7 @@ return {
     {
     {
       name = 'canvas',
       name = 'canvas',
       type = 'Canvas',
       type = 'Canvas',
-      description = 'The active Canvas, or nil if no canvas is set.'
+      description = 'The active Canvas, or `nil` if no canvas is set.'
     }
     }
   },
   },
   related = {
   related = {

+ 1 - 1
api/lovr/graphics/getShader.lua

@@ -7,7 +7,7 @@ return {
     {
     {
       name = 'shader',
       name = 'shader',
       type = 'Shader',
       type = 'Shader',
-      description = 'The active shader object, or nil if none is active.'
+      description = 'The active shader object, or `nil` if none is active.'
     }
     }
   }
   }
 }
 }

+ 1 - 1
api/lovr/graphics/setCanvas.lua

@@ -9,7 +9,7 @@ return {
     {
     {
       name = 'canvas',
       name = 'canvas',
       type = 'Canvas',
       type = 'Canvas',
-      description = 'The new active Canvas object, or nil to just render to the headset.'
+      description = 'The new active Canvas object, or `nil` to just render to the headset.'
     }
     }
   },
   },
   returns = {},
   returns = {},

+ 1 - 1
api/lovr/graphics/setDepthTest.lua

@@ -9,7 +9,7 @@ return {
       name = 'compareMode',
       name = 'compareMode',
       type = 'CompareMode',
       type = 'CompareMode',
       default = 'nil',
       default = 'nil',
-      description = 'The new depth test.  Use nil to disable the depth test.'
+      description = 'The new depth test.  Use `nil` to disable the depth test.'
     },
     },
     {
     {
       name = 'write',
       name = 'write',

+ 1 - 1
api/lovr/graphics/setFont.lua

@@ -7,7 +7,7 @@ return {
       name = 'font',
       name = 'font',
       type = 'Font',
       type = 'Font',
       default = 'nil',
       default = 'nil',
-      description = 'The font to use.  If nil, the default font is set.'
+      description = 'The font to use.  If `nil`, the default font is set.'
     }
     }
   },
   },
   returns = {},
   returns = {},

+ 1 - 1
api/lovr/headset/Controller/newModel.lua

@@ -6,7 +6,7 @@ return {
     {
     {
       name = 'model',
       name = 'model',
       type = 'Model',
       type = 'Model',
-      description = 'The new Model, or nil if a model could not be loaded.'
+      description = 'The new Model, or `nil` if a model could not be loaded.'
     }
     }
   },
   },
   notes = 'The Model will have a Texture applied.',
   notes = 'The Model will have a Texture applied.',

+ 1 - 1
api/lovr/thread/Channel/pop.lua

@@ -28,7 +28,7 @@ return {
     {
     {
       name = 'message',
       name = 'message',
       type = '*',
       type = '*',
-      description = 'The received message, or nil if nothing was received.'
+      description = 'The received message, or `nil` if nothing was received.'
     }
     }
   },
   },
   notes = 'Threads can get stuck forever waiting on Channel messages, so be careful.',
   notes = 'Threads can get stuck forever waiting on Channel messages, so be careful.',

+ 1 - 1
api/lovr/thread/Thread/getError.lua

@@ -8,7 +8,7 @@ return {
     {
     {
       name = 'error',
       name = 'error',
       type = 'string',
       type = 'string',
-      description = 'The error message, or nil if no error has occurred on the Thread.'
+      description = 'The error message, or `nil` if no error has occurred on the Thread.'
     }
     }
   },
   },
   related = {
   related = {