I am currently working on creating documentation for a straightforward typescript class:
export class Address
{
/**
* @param street { string } - excluding building number
* @param city { string } - abbreviations like "LA" are acceptable
*/
constructor(
private readonly street: string,
private readonly city: string){}
}
export class Person
{
/**
* @param name { string } - first name only
* @param address { Address } - residential address
*/
constructor(
private readonly name: string,
private readonly address: Address){}
}
After compiling it to *.js and generating a *.d.ts file:
$ ./node_modules/.bin/tsc --declaration main.ts
Upon running the documentation generation process, I am only getting the text Home displayed and nothing else:
$ ./node_modules/.bin/jsdoc --verbose ./main.js