Use esdoc for questions related to the ESDoc library, which is used to generate documentation from annotations and comments in ECMAScript
References
Questions tagged [esdoc]
12 questions
9
votes
2 answers
Is it possible to document a javascript plain object using ESDOC?
It seems that ESDOC targets only ES6 class style.
Is there a way to document a plain object like:
/**
* ???
*/
var Foo = {
/**
* ???
*/
info: true
};
export default Foo;
And even when using ES6 class style, how to document a…
Stéphane Francel
- 91
- 3
6
votes
0 answers
How to document object literals in ESDOC
The documentation doesn't mention it.
https://esdoc.org/manual/usage/tags.html
Anyone knows how to document object literals in ESDoc and generate a report that describes the object with all the methods and values. Would like to know how to document…
koningdavid
- 7,903
- 7
- 35
- 46
3
votes
1 answer
How does Typescript ESDoc measure comment coverage?
I am writing in Angular4 and Typescript with the esdoc-coverage-plugin and esdoc-typescript-plugin.
In my codebase, every method, class, and member have a comment block in this form:
/** @method methodName
* @desc method description
* @param…
Matt
- 51
- 3
2
votes
0 answers
ESDoc with TypeScript: how to use comment blocks?
I use ESDoc to generate a documentation for a JS project. It works well!
I now want to migrate this JS project into a TS project. For the documentation, I saw this plugin to help ESDoc handle TypeScript.
It kinds of work. By simply using the…
KorHosik
- 1,225
- 4
- 14
- 24
1
vote
1 answer
How to document an object containing objects with ESDoc
I am attempting to document an object containing other objects in a class constructor using ESDoc (similar syntax to JSDoc).
/**
* A description.
* @type {object}
*/
this.materialProperties = {
paper: {
roughness: 0.5,
…
Bar Smith
- 797
- 6
- 20
1
vote
1 answer
ESDoc: Ignoring Specific File
While trying to document a JavaScript file, an error occurred. To solve this issue, the strategy will follow a different direction. We aim to ignore the cause of the issue since the code do what we want.
For this project, we are using the ESDoc for…
Francisco Maria Calisto
- 2,841
- 4
- 22
- 54
1
vote
0 answers
EsDoc does not like to document plain objects at the member level - workaround?
Given the following construction:
BigBoss.specify({
/**
* EsDoc, will not show me
*/
val:'val',
/**
* EsDoc, will not show me
*/
fn:function(){
return 'fn';
}
// lots more members I want to documenent in EsDoc
});
And…
Mark Robbins
- 2,427
- 3
- 24
- 33
1
vote
1 answer
Using esdoc for jsx files
I want to generate document for .jsx files
.esdoc.json :
{
"source": "./src/",
"destination": "./doc"
}
But esdoc just use .js files in ./src to generate document.
So how do i config esdoc to generate document for .jsx files?
fingerpich
- 8,500
- 2
- 22
- 32
0
votes
0 answers
How do I document events with ESdoc?
Using ESDoc, is there a way to document events as used in code such as:
class Example extends EventEmitter {
doSomethingAsynchronously () {
....then( () => this.emit('anevent', params) )....
}
// and many other methods that can also…
Jason C
- 38,729
- 14
- 126
- 182
0
votes
1 answer
ESDoc: How to exclude a dir
I have 2 directories, one to keep to generate documentation and not the other one. They're:
client-dev
client
Directory client-dev is to be included in generating documentation. The other one, client should not be included.
My .esdoc.json file:
{
…
Dee
- 7,455
- 6
- 36
- 70
0
votes
1 answer
Create links between ESDoc functions/classes and manual pages and vica-versa
I'm new to ESDoc but have many years JSDoc experience.
The nearest equivalent to JSDoc's Tutorials features is ESDoc's Manual feature. It lets you write stand-alone markdown documentation that gets incorporated into the final built documentation.
I…
Bart B
- 661
- 8
- 18
0
votes
2 answers
running esdoc's got error
to generate document i want to use esdoc
esdoc -c esdoc.json
esdoc.json
{
"source": "./src/",
"destination": "./doc"
}
./src/index.js
/**
* @type {Object}
* @property {boolean} Foo.info
*/
var Foo = {
info: true
};
export default…
fingerpich
- 8,500
- 2
- 22
- 32