Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it possible to @{ref} a section? #342

Open
jtackaberry opened this issue Jan 6, 2021 · 0 comments
Open

Is it possible to @{ref} a section? #342

jtackaberry opened this issue Jan 6, 2021 · 0 comments

Comments

@jtackaberry
Copy link

I'm grouping a lot of fields with @section tags with some preamble and want to be able to reference the section. For example:

--- Foo constants.
--
-- These constants define various foos and bars to be used with e.g. @{mymod.foobar}
--
-- @section fooconsts

--- Const 1
FOO_1 = 1
--- Const 2
FOO_2 = 2

-- ... somewhere later ...

--- Runs a foobar
--
-- @tparam number c one of the @{fooconsts|foo constants}.
function mymod.foobar(c)
end
---

But this reference fails to resolve.  Is there some way I can accomplish the above such that it works across modules?

Thanks!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant