question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Internal links in documentation

See original GitHub issue

Is there any way of declaring an internal reference to a part of the documentation via a comment block.

e.g.

/**
 * Some function that does something. Also see {@link someOtherFunction}.
 */
public someFunction(): void {
    ...
}

Issue Analytics

  • State:closed
  • Created 9 years ago
  • Comments:10 (8 by maintainers)

github_iconTop GitHub Comments

5reactions
janispritzkaucommented, Oct 4, 2016

How would I declare a reference to a static and a instance member? I’ve tried [[Class:method]] [[Class::method]] [[Class#method]]. If there’s a static and instance method with the same name, [[Class.method]] creates a link to the static method.

5reactions
awerlangcommented, Feb 7, 2015

It is working for same class members and to link to another class.

How to link to another class’ member?

interface Entity {
   id: number;
}
class EntityService {
    /**
     * @param id   see [[Entity.id]]
     */
    get(id: number) {...}
}
Read more comments on GitHub >

github_iconTop Results From Across the Web

Add hyperlinks to a location within the same document
Select the text or object you want to use as a hyperlink. Right-click and then click Hyperlink Hyperlink button . Under Link to,...
Read more >
Google Docs: Linking Within a Document - GCF Global
Learn how to link within your document using headings and bookmarks in this free lesson. ... Links usually take you outside of Google...
Read more >
Internal Links - DocSend Help Center
Create an Internal Link · Select the desired document from the Content page. · Click the Create Link arrow to open the “more...
Read more >
Internal Links (The Org Manual)
4.2 Internal Links. A link that does not look like a URL—i.e., does not start with a known scheme or a file name—refers...
Read more >
How to Create an Internal Document Link in Microsoft Word
Just as a website needs an address before you can link to it, a Microsoft Word document needs internal addresses before you can...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found