Merge pull request #3257 from tommaisey/alias-enum-doc-export

@alias and @enum file paths

Author: sumneko

changelog.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 <!-- Add all new changes here. They will be moved under a version at release -->
+* `NEW` Doc output now contains file paths for `@alias` and `@enum` types
 * `FIX` Typos in a few error messages.
 * `FIX` Incorrect inject-field message for extra table field in exact class
 * `CHG` Rename configuration option `Lua.diagnostics.disableScheme` to `Lua.diagnostics.validScheme` and improve its description. Now it enables diagnostics for Lua files that use the specified scheme.

script/cli/doc/export.lua

@@ -147,7 +147,11 @@ export.makeDocObject['INIT'] = function(source, has_seen)
 end
 
 export.makeDocObject['doc.alias'] = function(source, obj, has_seen)
+    obj.file = export.getLocalPath(guide.getUri(source))
+end
 
+export.makeDocObject['doc.enum'] = function(source, obj, has_seen)
+    obj.file = export.getLocalPath(guide.getUri(source))
 end
 
 export.makeDocObject['doc.field'] = function(source, obj, has_seen)
@@ -256,6 +260,7 @@ export.makeDocObject['variable'] = function(source, obj, has_seen)
         or set.type == 'setmethod'
         or set.type == 'setindex'
         or set.type == 'doc.alias'
+        or set.type == 'doc.enum'
         or set.type == 'doc.class'
         then
             table.insert(obj.defines, export.documentObject(set, has_seen))

script/core/hover/description.lua

@@ -507,7 +507,7 @@ local function tryDocEnum(source)
                 end
                 if field.value.type == 'integer'
                 or field.value.type == 'string' then
-                    md:add('lua', ('    %s: %s = %s,'):format(key, field.value.type, field.value[1]))
+                    md:add('lua', ('    %s: %s = %q,'):format(key, field.value.type, field.value[1]))
                 end
                 if field.value.type == 'binary'
                 or field.value.type == 'unary' then