search

trotttrotttrott / jsonnetdoc

Documentation parser for JSDoc style comments in Jsonnet.
Apache License 2.0
6 stars 1 forks source link

Can use JSDoc directly #1

Open emschwartz opened 2 years ago

emschwartz commented 2 years ago

For anyone else looking to document Jsonnet code, you can actually use JSDoc directly. JSDoc has a commentsOnly plugin that is designed to allow documenting non-Javascript code with JSDoc.

To make it work, you need a JSDoc config file that looks something like:

{
    "source": {
        "includePattern": ".+\\.(j|lib)sonnet$"
    },
    "plugins": [
        "plugins/commentsOnly"
    ]
}
jmgilman commented 1 year ago

Thanks for the tip. Are there any other active projects in this space?