search

naver / jsdoc-to-mdx

jsdoc to mdx API document generator
https://naver.github.io/jsdoc-to-mdx/
MIT License
18 stars 4 forks source link

Global functions #4

Closed birdofpreyru closed 2 years ago

birdofpreyru commented 2 years ago

It looks like a great library! One caveat I came across: it does not include global functions (and I guess some other global objects) into documentation. That is because the only global objects collected in the current version are: classes, interfaces, namespaces, constants, and typedefs; while functions are only picked up if they are members of some of those global objects. I guess, that should be super-easy to correct, if there is no particular reasons to omit them?

WoodNeck commented 2 years ago

Hello @birdofpreyru! This module is tested only by Flicking and InfiniteGrid by now, so it's just not fully tested on all other kinds of source codes. There's no reason to omit it, I should fix that :)