Global functions aren't exported

[Nightmare82]

When I export documentation it contains all my types and their methods but the global functions are missing.

As an example this is how a file looks like and the function isn't part of the exported documentation:

---@meta

---@return string String parameter
---@param propertyName string name of the property
---@param defaultValue string Default value
---@param description string Description of the property
function getStringParameter(propertyName, defaultValue, description)
end

Is this a bug or am I doing something wrong ?

My goal is to document all functions of my custom engine. It works nicely for all my types and methods but seems like I'm doing something wrong for the functions.

[carsakiller]

Try removing the @meta annotation. I think the documentation generation is meant to generate documentation from your code, not your definition files (as those would have already been generated, in theory).

[Nightmare82]

Try removing the @meta annotation. I think the documentation generation is meant to generate documentation from your code, not your definition files (as those would have already been generated, in theory).

Thanks for the suggestion! Unfortunately this doesn't change the behavior in my test. I will try it with a minimal example to make sure it's not a side effect of something else at next.

[Nightmare82]

It also doesn't work with a minimalistic example(a single function), with or without the meta annotation

[sumneko]

I missed this case since I never used global functions

[Nightmare82]

I missed this case since I never used global functions

Ok, thanks for the confirmation! Do you plan to add that in the near future ? Otherwise maybe I will rework my API to not use global functions.(Which sounds like a good choice anyway 😀)

[Nightmare82]

Thanks for adding support for that!

Do I have to do anything special to be able to export global functions ? It doesn't work for me with the example posted above. (With or without the meta annotation) @sumneko (Version 3.6.17)

[sumneko]

Could you provide a demo file for me to test?

[Nightmare82]

@sumneko The example I mentioned above in a single lua file doesn't produce any output for example.
An even more minimal example would be:

---@meta

function dummy() end

If there is any other way to export global functions please let me know.

[sumneko]

@sumneko The example I mentioned above in a single lua file doesn't produce any output for example. An even more minimal example would be:

---@meta

function dummy() end

If there is any other way to export global functions please let me know.

Currently I would not export anything from meta files, since I don't want to export basic functions (e.g. io.open, math.random).
I will find another way to exclude basic functions.

[Nightmare82]

@sumneko in the newest version this is supported, right ? how is it supposed to work ?

[Nightmare82]

@sumneko Could you please give me an update if this feature is supposed to work now ? (And if it is could you tell me how to export global functions)

[Nightmare82]

Sorry, this time it was an error on my side, it works great. Thanks a lot for adding this feature!