You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I used an inline {@link} doc in one of my classes which links to a class definition. Both class definitions are located in the same source file. See the code below for an example.
exportclassLoggerOptions{level: string;}/** * */
@Injectable()exportclassLoggerService{/** * Instantiates new Logger instance. By default a logger is instantiated with a set of default options. * Override these options by passing a {@link LoggerOptions} object to the constructor. * * @param {LoggerOptions} options */publicconstructor( @Optional()options?: LoggerOptions){// some code}}
When I generate the documentation with Compodoc, the links for the parameters get generated correctly. The generated link for the inline comment is wrong however. Because it's missing a /, it appends the URL to the URL path of the current page. See the image below (red is wrong, green is correct):
@vogloblinsky I think this may need to be re-opened as this still seems to be an issue in beta-14 for me when an {@link ...} is used on a function that will later be placed in the miscellaneous/ folder. The link generated from them lacks the leading ../
I'm seeing this also. When linking from a type definition to a component, the generated URL doesn't take into account the new nesting of the type inside miscellaneous.
This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.
lockbot
locked as resolved and limited conversation to collaborators
Oct 1, 2019
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Overview of the issue
I used an inline {@link} doc in one of my classes which links to a class definition. Both class definitions are located in the same source file. See the code below for an example.
When I generate the documentation with Compodoc, the links for the parameters get generated correctly. The generated link for the inline comment is wrong however. Because it's missing a
/
, it appends the URL to the URL path of the current page. See the image below (red is wrong, green is correct):Operating System, Node.js, npm, compodoc version(s)
The text was updated successfully, but these errors were encountered: