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

all tags above a function are ignored by the dox.api #99

Closed
kof opened this issue May 20, 2013 · 3 comments
Closed

all tags above a function are ignored by the dox.api #99

kof opened this issue May 20, 2013 · 3 comments

Comments

@kof
Copy link

kof commented May 20, 2013

If function has context.type == 'function'.

However they are correctly parsed, just the .api function ignores them

So I can't produce a documentation for constructor params f.e.

Example:

test.js

/**
 * My test
 *
 * @param {Object}
 * @return {Number}
 * @api public
 */
function test(opts) {
    return 123;
}

And then run:

dox < test.js --api

The result is

  - [test()](#test)

## test()

  My test
@kof
Copy link
Author

kof commented May 20, 2013

Will you accept a pull or want to fix it?

@kof
Copy link
Author

kof commented May 20, 2013

the same is actually for all context types except of method ....

@tj
Copy link
Owner

tj commented May 21, 2013

weird i must not have finished that, it was pretty rushed, a PR would be great!

@Twipped Twipped closed this as completed Mar 18, 2015
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

3 participants