[Feature Request] Documentation for functions about documentalist HOT 8 CLOSED

here are the types it visits: https://github.com/palantir/documentalist/blob/master/src/plugins/typescript/visitor.ts#L44-L57. you can probably guess how to add functions.

from documentalist.

@streamich at the moment documentalist does not support function variables, but this would be easy to add in the typescript plugin.

from documentalist.

This library is basically my last only hope for generating types from TS at this point. I used to use react-docgen but that only works with Flow. I used Typedoc for a while, but its type declarations were INCREDIBLY complicated, and the JSON files up to 10 megs for a simple component...

My main issue is I'm not able to get any information from the Functional components in my docs. I really need the comment blocks that are associated with them... I poked around in the code but I don't know enough about it to find a way to include function declarations into the export JSON.

Any help would be great, I'm close to releasing my updated docs for https://jamesmfriedman.github.io/rmwc/ but this is a hurdle I still need to overcome.

from documentalist.

@jamesmfriedman one thing this library does really well is interfaces. If you declare interfaces for your functions then documenting them shouldn't be too hard.

For my functional components, I specify an interface for the props it needs and put any relevant comments on the interface.

from documentalist.

Thanks for the quick reply! Yeah I saw that as a workaround but VSCode and other tools read the main comment off the component itself. I might just go the route of having duplicate comments unless you know some other magical workaround.

from documentalist.

@jamesmfriedman Good point! I wonder how VsCode is doing it :)

from documentalist.

from documentalist.

Fixed by #104

from documentalist.