Plugin framework for documentation
mmomtchev opened this issue · 4 comments
Suggestion: Implement a plugin framework allowing to easily extend documentation
I have two distinct use cases for this:
- Being able to add a parser (for example C++) and to hook it in
buildInternal
alongparseJavaScript
and also inisJSDocComment
- Being able to support custom jsdoc tags - by plugging in the parser itself by tag name - as I have a very specific need, namely having a very large number of synchronous and asynchronous functions with the same parameters (+ callback for the async versions) that I need to be ideally able to document with a single block as to avoid any errors and render future maintenance easier
I am willing to work on an implementation if we can settle on a (somewhat) stable API
@anthony-redFox @tmcw any suggestions on that one? I implemented what I needed and I am using it for gdal-async
and a couple of other Node.js addons
Hello, give me a time I will try to review what are did, then suggest the next steps.
So my steps to do like :
- replace doctrine on something supported.
- Create a build which pack in to one file like prettier without deps.
- Have a alfa release to make sure that everyone who use documentation have a feedback about bugs and features drop (migration stuff)
I am afraid there is a good replacement for doctrine - I don't know why no one has stepped in to maintain it
@anthony-redFox @tmcw - support for custom jsdoc tags already exists - you can do it by theming, since the theme will receive all the tags - even those that haven't been recognized