Skip to content

Fix namespace paths in type autolinking #197

New issue
New issue
Closed
#1151
Closed
Fix namespace paths in type autolinking#197
#1151
Labels
bug
@tmcw

Description

@tmcw
tmcw
opened on Oct 19, 2015
Member
/** Represents an HTTP response.
 *    @typedef {Object} HttpResponse
 *    @memberof request
 *    @static
 */

/** Example that doesn't work
 *    @function
 *    @param {request.HttpRequest} req - The request object
 */

Here's our current autolink code:

documentation/lib/html_helpers.js

Lines 68 to 75 in 85ff395

function autolink(paths, text) {
if (paths.indexOf(slug(text)) !== -1) {
return '<a href="#' + slug(text) + '">' + text + '</a>';
} else if (getGlobalExternalLink(text)) {
return '<a href="' + getGlobalExternalLink(text) + '">' + text + '</a>';
}
return text;
}
- this isn't getting the right paths generated.

Activity

tmcw
added
bug
on Oct 19, 2015
developit

developit commented on Oct 19, 2015

@developit
developit
on Oct 19, 2015

Thanks :)

tmcw
added this to the 3.0.0 milestone on Oct 27, 2015
tmcw

tmcw commented on Oct 27, 2015

@tmcw
tmcw
on Oct 27, 2015
MemberAuthor

Depends on #189

tmcw
removed this from the 3.0.0 milestone on Oct 27, 2015
tmcw

tmcw commented on May 5, 2016

@tmcw
tmcw
on May 5, 2016
MemberAuthor

New autolinking approach in v4 fixes this.

tmcw
closed this as completedon May 5, 2016
dmp42

dmp42 commented on Sep 20, 2016

@dmp42
dmp42
on Sep 20, 2016

Using documentation 4.0.0-beta10 this is not (yet) working. Should this be reopened?

dmp42

dmp42 commented on Sep 20, 2016

@dmp42
dmp42
on Sep 20, 2016 · edited by dmp42

Clarifying: the original example works as expected.

If you omit @static though:

  • Request is still listed as a static member of http
  • though the actual namespace for it is httpRequest (lacking dot)

To reproduce:

/**
 * @type class
 * @name http
 */

/**
 *
 * @typedef {Object} Request
 * @memberof http
 */

/**
 *
 * @typedef {Object} Request2
 * @memberof http
 * @static
 */

/**
 * @name foo
 * @type function
 * @param {http#Request} a
 * @param {http.Request} b
 * @param {httpRequest} c
 * @param {http#Request2} d
 * @param {http.Request2} e
 * @param {httpRequest2} f
 * @returns {httpRequest}
 */
lcharbon
added 2 commits that reference this issue on Oct 12, 2018

fix: Update scope for a comment that is memberof an other to defaults…

97a22a0

fix: Update scope to default to static when memberof

59325ea
lcharbon
mentioned this on Oct 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bug

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @tmcw@developit@dmp42

      Issue actions
        Fix namespace paths in type autolinking · Issue #197 · documentationjs/documentation