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

@alias should not override name and longname #1217

Closed
onury opened this issue May 31, 2016 · 1 comment
Closed

@alias should not override name and longname #1217

onury opened this issue May 31, 2016 · 1 comment

Comments

@onury
Copy link

onury commented May 31, 2016

Documentation

/**
 *  ...
 *  @alias lib.secondaryName
 *  @memberof lib
 */
function originalName() { .. }

outputs:

{
    "code": {
        "name": "lib.originalName", // original name is only documented here
        ...
    },
    "alias": "lib.secondaryName", // alias
    "name": "secondaryName", // alias
    "longname": "lib.secondaryName", // alias
    ...
}

This is misleading. Since aliases are secondary names, the name and longname of the symbol should be kept unchanged. We already have the alias documented.

@hegemonic
Copy link
Contributor

The whole point of the @alias tag is to treat the symbol as though it had a different longname. See the docs for this tag. Sorry, but we can't change this tag's behavior without breaking a lot of people.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants