Generate markdown documentation from jsdoc-annotated javascript
renderSync https://github.com/jsdoc2md/jsdoc-api/issues/21
--html option due to lack of use.async or await statements natively, without use of a babel plugin.
Upgrade recommended. There are no API changes in v4.0.0, it is backward compatible. Assuming you don't need --html you can upgrade safely.
This is an optimisation release. By removing the requirement for polyfill libraries (core-js, babel-polyfill etc), the jsdoc2md dependency tree has shrunk to half its previous size.
There are no functional changes in this particular release.
Upgraded the dependencies and added the usage stats as described in the v2.0.0 release.
No further releases are planned for jsdoc2md version 1.
This release is intended to freshen up the codebase and make a few improvements while longer-term goals continue to be developed. The majority of improvements relate to performance, the API and dependency tree cleansing - the data and rendered docs output are largely unchanged. For now.
source option added, you can now pass in source code as a string.--namepaths returns all namepaths found in the supplied code--source takes source code in as a string. Useful in scripting.--jsdoc returns the raw, unchanged jsdoc data.--clear clears the cache--no-cache skips the cache--version
-c is now the alias for --configure instead of --member-index-format to match the jsdoc -c option.--conf option renamed to --configure to match the jsdoc --configure option.--src option renamed to --files to avoid confusion between --src and --source
--sort-by and --group-by removed for now, back in a future version or by popular demand.kind (like member, class etc.) not doclet property, as before. The isEnum property in the --json (and jsdoc-parse) output has gone.@private and @ignored doclets and are now left in the --json (jsdoc-parse) data, and filtered out at template (dmd) level instead.Old package and deprecation warnings should now be gone.
Fresh tutorials in the wiki, more to come.
I'm curious to know whether i can drop node 0.10 or 0.12 support. Also, i'd like to know which features are used/unused, need improving or better documentation. So, the tool keeps count of the features and node versions used. Only count totals are sent, no data, filenames or source code.
To disable collection of stats, run this command:
$ echo '{ "no-usage-stats": true }' > ~/.jsdoc2md.json
This release is intended to freshen up the codebase and make a few improvements while longer-term goals continue to be developed. The majority of improvements relate to performance, the API and dependency tree cleansing - the data and rendered docs output are largely unchanged. For now.
source option added, you can now pass in source code as a string..clear() method added - clears the cache.--source takes source code in as a string. Useful in scripting.--jsdoc returns the raw, unchanged jsdoc data.--clear clears the cache-c is now the alias for --configure instead of --member-index-format to match the jsdoc -c option.--conf option renamed to --configure to match the jsdoc --configure option.--src option renamed to --files to avoid confusion between --src and --source
--sort-by and --group-by removed for now, back in a future version or by popular demand.kind (like member, class etc.) not doclet property, as before. The isEnum property in the --json (and jsdoc-parse) output has gone.@private and @ignored doclets and are now left in the --json (jsdoc-parse) data, and filtered out at template (dmd) level instead.Old packages and deprecation warnings should now be gone.
I'll write a fresh set of documentation (tutorials and an FAQ) next, making more use of the Wiki.
I'm curious to know whether i can drop node 0.10 or 0.12 support. Also, i'd like to know which features are used/unused, need improving or better documentation. So, the tool will now keep count of the options and node versions used. Only counts/stats are sent, no filenames or source code. Please read the usage-stats docs and source for all the details. You're welcome to view the stats, just send me a google account email and i'll grant you read access to the reports.
To disable collection of stats, run this command:
$ echo '{ "no-usage-stats": true }' > ~/.jsdoc2md.json
$ npm install -g jsdoc-to-markdown@^2.0.0-alpha
Related repos: https://github.com/jsdoc2md/jsdoc-to-markdown/tree/next https://github.com/jsdoc2md/jsdoc-api https://github.com/jsdoc2md/jsdoc-parse/tree/next https://github.com/jsdoc2md/dmd/tree/sync