doxdox

doxdox copied to clipboard

This PR was automatically created by Snyk using the credentials of a real user.Snyk has created this PR to fix one or more vulnerable packages in the `npm` dependencies of...

neogeek

Create option to not show private methods

3

Right now private methods are generated. It's necessary to add an option to not show those private methods. This is [the line](https://github.com/neogeek/doxdox-parser-dox/blob/a9f24453b8245c231f2c033292ca4ab2d8c2edcc/index.js#L59) that would need changing (I think): From ->...

taylorjdawson

Many comments are not supported

5

Hi @neogeek , Jsdoc3's some comments are not supported in the doxdox，For example: ```js /** * @constant * @default */ const RED = 0xff0000; ``` doxdox only render `Methods`, but...

gongph

If you are having issues running doxdox on Windows due to permissions, see the following link for more information. https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.2 To get doxdox working, run the following command from Windows...

neogeek

This repository is undergoing a massive rewrite. Things will be missing, broken, or incomplete as development continues.

neogeek

How to document curried functions?

1

How do I document curried functions like this? ```javascript const map = func => iterable => {} ```

joelnet

why is it generating extra column in markdown tables?

2

I see extra column being generated in markdown tables filled with `|   |`. What is the reasoning behind this and can this be disabled?

agauniyal

support annotations from closure compiler (that jsdoc does not have)

1

I found there are some properties I'd like to document that jsdoc does not have built in https://github.com/esdoc/esdoc/issues/347 http://stackoverflow.com/questions/25314979/documenting-side-effects-of-javascript-methods https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#nosideeffects-modifies-thisarguments

aretecode

I am using the 4.0.0-preview.13 version, but its not working. ` (node:562824) UnhandledPromiseRejectionWarning: Error: node_modules directory was not found at file:///../node_modules/doxdox-cli/dist/src/index.js:65:15 (Use `node --trace-warnings ...` to show where the warning...

JeissonEsteban

neogeek