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

using @requires {@link} does not replace the requirement with a link #140

Open
CarbonCollins opened this issue Sep 26, 2017 · 4 comments
Open
Labels
template Requires a change to a dmd partial/helper

Comments

@CarbonCollins
Copy link

CarbonCollins commented Sep 26, 2017

Hi,

When using the @requires tag along with the {@link} the requirement is not replaced with a link but instead the link text is used e.g. using:

/**
 * @summary A sumary here
 * @requires {@link ./services/log.md#log|module:log}
 * @requires module:socket
 */

will return in the md:

Summary: A sumary here
Requires: {@link ./services/log.md#log|module:log}, module:socket

The module themselves are in different files which have a separate md file, hence the wanting to be able to use the @link tag

@75lb
Copy link
Member

75lb commented Sep 26, 2017

that doesn't look like a valid @link value.. please check the docs and ensure your link works correctly in jsdoc first, please.

@75lb 75lb closed this as completed Sep 26, 2017
@CarbonCollins
Copy link
Author

CarbonCollins commented Sep 26, 2017

the link does work correctly when used with a @see tag and i have tried it in all of these formats as per the docs:

{@link namepathOrURL}
[link text]{@link namepathOrURL}
{@link namepathOrURL|link text}
{@link namepathOrURL link text (after the first space)}

the same link tag also works in inline descriptions however does not work in @requires

@75lb 75lb reopened this Sep 26, 2017
@75lb
Copy link
Member

75lb commented Sep 26, 2017

hmm, ok - thanks for confirming.. on first glance ./services/log.md#log did not, and still doesn't look like a reliable URL (it's relative and md files do not have anchor links) but I will check.

@g-viet
Copy link

g-viet commented Oct 12, 2018

is it still opening ?
{@link SampleClass} is not fixed.

@75lb 75lb added the template Requires a change to a dmd partial/helper label Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
template Requires a change to a dmd partial/helper
Development

No branches or pull requests

3 participants