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

How to put a mail address link in the comments? #2613

Closed
crystalfp opened this issue Jun 24, 2024 · 1 comment
Closed

How to put a mail address link in the comments? #2613

crystalfp opened this issue Jun 24, 2024 · 1 comment
Labels
bug Functionality does not match expectation question Question about functionality
Milestone

Comments

@crystalfp
Copy link

Search terms

link,mail

Question

Want to add the mail address of the author in the comment, but typedoc complains. The file header comment is:

/**
 * Creating/closing windows and setup communications to them
 * @packageDocumentation
 * @author [John Doe](mailto:jdoe\@example.com)
 */

And the error is:

./src/electron/modules/WindowsUtilities.ts:6:25 - [warning] The relative path mailto:jdoe@example.com does not exist

Tried also with {@link mailto:jdoe\@example.com} with the same result. Seems the only solution is to put the mail address as a normal string:

 * @author John Doe "jdoe\@example.com"

Any suggestion?
Thanks!
mario

@crystalfp crystalfp added the question Question about functionality label Jun 24, 2024
@Gerrit0 Gerrit0 added the bug Functionality does not match expectation label Jun 24, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 24, 2024

That's a bug, TypeDoc shouldn't be recognizing that as a relative link

@Gerrit0 Gerrit0 added this to the 0.26.3 milestone Jun 25, 2024
Gerrit0 added a commit that referenced this issue Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants