Hi @tmcw
If I want to create docs from the following code:
type CaptureEmail = {
email: string,
url: string,
}
const Engage = {
/**
* Captures users email upon leaving booking page
*/
captureEmail: (data: CaptureEmail): Promise<CaptureEmail> => {
}
}Do I need latest master changes?
Whats the best practise to document helpers functions?
Consider this documentation http://8e3aa602.ngrok.io/
This is a function thats used internally,
./src/utilities/isCookieSet.
Having it here without any context makes little sense.
Is there a way to at least group them under some namespace "utilities"?
I've tried "separate_auth" too which is what documentation generates in the output
Seems only items which aren't members of a namespace are considered
jest doesn't seem to be running the fixture *.input.js tests
hey just to say thanks for the project!
i'm happy with how my heavily hacked documentation.js site came out:
mpe.js.org
tmcw: Is this still the correct place to discuss documentation.js?
@tmcw ^
@odub Di you see this too?
It works well if I use the default theme
@odub Hmm, the default theme being the one here - (https://github.com/documentationjs/documentation/tree/master/src/default_theme
I also want to keep the theme 'external' in that it'll be a separate npm dependency, I'll be calling it like
documentationjs buil…-t node_modules/my-theme/ -o docs
It seems
@const some-variable-name-with-dashes gets parsed to an object with name simply “some”. Does anyone know if this is standard JSDoc, or something in documentationjs?
"tags": [
{
"title": "const",
"description": “-variable-name-with-dashes",
"lineNumber": 3,
"type": null,
"name": “some"
}
}
Does anyone know if documentationjs can be used with JSDoc plugins?
Hi, I am using documentationjs for generating markdown from JSdoc, I have written in the jsdoc [val=true] next to my boolean, I expect to have it rendered so it is nicely displayed as default option. Instead, I have [val=true] (the same), and it does not look nice in markdown. Is this how we generate default in JSdom?
