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

Support functions made by factories #300

Closed
megawac opened this Issue Jun 19, 2016 · 2 comments

Comments

Projects
None yet
3 participants
@megawac
Copy link

megawac commented Jun 19, 2016

I've been trying to setup esdoc in asyncjs as part of caolan/async#1191 but noticed an issue with documenting functions generated by other functions. Example file. In this file doLimit creates a wrapper function around eachOfLimit.
I was expecting adding a @type Function would do the trick and put the docs under the corresponding @name, however these functions have not been showing up in the generated output

@typhonrt

This comment has been minimized.

Copy link
Contributor

typhonrt commented Jun 28, 2016

@type is only picked up when documenting a member of a class as far as I'm aware.

IE:

export default class Foo
{
   constructor()
   {
       /**
        * A crazy bar string...
        * @type {string}
        */
       this.bar = 'value';
   }
}

Even adding @returns to your example will not add a function to the docs per se. For the example supplied I suppose @returns may provide a variable entry into the docs?

@h13i32maru

This comment has been minimized.

Copy link
Member

h13i32maru commented Dec 31, 2016

ESDoc does not support it. Because ESDoc generates doc from concrete codes. A Dynamically codes (aka meta programming) is not targeted of ESDoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment