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

Aliases aren't documented #1251

Closed
megawac opened this issue Jul 22, 2016 · 1 comment
Closed

Aliases aren't documented #1251

megawac opened this issue Jul 22, 2016 · 1 comment

Comments

@megawac
Copy link
Collaborator

megawac commented Jul 22, 2016

The documentation is missing aliases (e.g. forEach and forEachOf)

/cc @hargasinski know a quick fix?

@hargasinski
Copy link
Collaborator

I don't think so, but I'll look at the code tonight. I should be able to have a fix ready sometime this weekend. Thanks for noticing it.

It seems like minami just never implemented support the tag because, from a quick skim of the jsdoc alias docs, it looks like the expected behaviour of @alias is different then what we're using it for. @alias is meant to rename the function, as opposed to adding an actual alias.

For example, when JSDoc processes the following code, it recognizes that foo is a function, then renames foo to bar in the documentation:

/**
 * Bar function.
 * @alias bar
 */
function foo() {}

I'll add a fix for our needs somewhere, most likely in the theme/publish.js, and open a PR this weekend.

megawac added a commit that referenced this issue Jul 25, 2016
added alias documentation, fixes #1251
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants