Questions tagged [documentationjs]
8 questions
8
votes
3 answers
Grouping Functions In JSDoc Generated Documentation
I'm using documentationjs (which uses jsdoc under the hood) to handle the generation of docs for a lib I'm working on. My lib is written is ES6 and is fully functional, and at present the documentation generated is an alphabetical list of all the…
Undistraction
- 38,727
- 46
- 165
- 296
3
votes
1 answer
How to change theme in documentation.js?
I would like to use this theme for my documentation.
I use documentationjs. I tried a lot of things but I have no idea how to use it, can somebody help?
thanks
Lueton
- 124
- 1
- 9
2
votes
1 answer
How to document an object within a class constructor?
I am currently using JSDoc to attempt to document the following code...
class Test {
/**
* @param {Object} raw The raw data.
*/
constructor(raw) {
/**
* Used for things and stuff. It can be useful when referencing…
FireController1847
- 663
- 1
- 7
- 20
1
vote
1 answer
How to include and exclude directories for parsing with documentationjs
In particular, I'm interested in excluding any node_modules folders, but there are others that need to be excluded.
This is normally accomplished in a config file; e.g., a .jsdoc file, like so:
"source": {
"include" : ["../projects"],
…
kmiklas
- 11,204
- 17
- 55
- 84
0
votes
0 answers
Can't generate proper Documentation for React Native project
I have a react native project with Flow, for some reason the documentation does not show the actual types of the given component but instead it only shows props as Parameters.
type Props = {
name?: string,
age?: number,
};
const User =…
isni halsi
- 13
- 4
0
votes
1 answer
How to deploy a documentation page
I created a library with a demo page that I deployed it using Netlify (the url is something like my-lib.netflify.app) and it is associated with "build": "parcel build demo/index.html --out-dir demo-build",.
Then I add to my library a documentation…
whitecircle
- 356
- 3
- 12
0
votes
0 answers
Documentation.js yml fields
I'm new to documentation.js and I'm trying to understand how to change the documentation.yml file to configure mu documentation structure.
The doc doesn't say enough.
What are the fields that can I use? Is there a doc about that?
My library exports…
whitecircle
- 356
- 3
- 12
0
votes
1 answer
Can I export type in documentationjs and link it in a reference type in @param?
What I want to do looks like this:
/**
* @class OrganizationDescriptor
*/
export type OrganizationDescriptor = {|
organizationId: string
|};
and then when I use this type as a parameter, document it:
/**
* @param {OrganizationDescriptor}…
vljs
- 820
- 7
- 13