per https://github.com/TypeStrong/typedoc/issues/603, I have this at the top of one of my files:
/**
* @copyright <our copyright here>
*/
/** ignore this comment */
import * as _ from "lodash";
but it is not reflected in the output produced by generateJson(). Is this expected?
Here are how my options are configured:
target: "ES6",
excludeExternals: false,
ignoreCompilerErrors: true,
mode: "module",
experimentalDecorators: true
Any help would be appreciated!
Could you provide an example of where this fails? I just checked and was unable to reproduce with your options (after changing mode to "modules" - "module" isn't a valid value)
// File is in the root of the TypeDoc repo, I added a module comment to paths.ts for testing purposes.
const td = require('./dist');
const app = new td.Application({
target: 'es6',
excludeExternals: false,
ignoreCompilerErrors: true,
mode: 'modules',
experimentalDecorators: true
});
const result = app.generateJson(['./src/lib/utils/paths.ts'], './test.json');
console.log(result);
This gives me the following json:
{
"id": 0,
"name": "typedoc",
"kind": 0,
"flags": {},
"children": [
{
"id": 1,
"name": "\"paths\"",
"kind": 1,
"kindString": "External module",
"flags": {
"isExported": true,
"isExternal": true
},
"originalName": "src/lib/utils/paths.ts",
"comment": {
"shortText": "Module comment"
},
Ugh, typical. Moving too fast. It was simply the fact that I used "module" instead of "modules"...
Appreciate the help.
Most helpful comment
Ugh, typical. Moving too fast. It was simply the fact that I used "module" instead of "modules"...
Appreciate the help.