fix: Fix type links to @type class sections#424
Open
zhaojh329 wants to merge 2 commits intolunarmodules:masterfrom
Open
fix: Fix type links to @type class sections#424zhaojh329 wants to merge 2 commits intolunarmodules:masterfrom
zhaojh329 wants to merge 2 commits intolunarmodules:masterfrom
Conversation
LDoc generates class section anchors as `Class_<Name>` (e.g. `Class_file`), but type references like `@treturn file` were linking to `#file`, causing broken navigation. Adjust reference resolution so `@type`/`@factory` section targets use the corresponding `Class_<Name>` anchor. Signed-off-by: Jianhui Zhao <zhaojh329@gmail.com>
When resolving type-context references (e.g. @TReturn, @tparam), prefer class sections (@type/@factory) over same-named functions. This prevents collisions like @type inotify vs inotify() from linking to the function anchor. As a result, generated docs link return types like inotify to #Class_inotify instead of #inotify. Signed-off-by: Jianhui Zhao <zhaojh329@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
LDoc generates class section anchors as
Class_<Name>(e.g.Class_file), but type references like@treturn filewere linking to#file, causing broken navigation.Adjust reference resolution so
@type/@factorysection targets use the correspondingClass_<Name>anchor.