Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

--entryPoint is broken for .d.ts files #511

Closed
mad-gooze opened this issue May 22, 2017 · 3 comments
Closed

--entryPoint is broken for .d.ts files #511

mad-gooze opened this issue May 22, 2017 · 3 comments
Labels
question Question about functionality

Comments

@mad-gooze
Copy link

Hello!

I am trying to use typedoc to generate documentation for .d.ts declaration file. I specify this file as an entry point via --entryPoint '\"api.d\"' like I found in this discussion.
I am getting this error:
Warning: The entry point `"api.d"` could not be found.
and --entryPoint option is ignored.
I've researched the sources and it looks like that .d suffix gets omitted here:
https://github.com/TypeStrong/typedoc/blob/master/src/lib/models/reflections/abstract.ts#L511

Are there any fixes for my issue?

@ghost
Copy link

ghost commented Jul 3, 2017

Did you try with --includeDeclarations? I've managed to get it working once before, while using this flag.

@blakeembrey blakeembrey added question Question about functionality awaiting response labels Jul 25, 2017
@mootari
Copy link

mootari commented Dec 10, 2017

I managed to get it working by passing entryPoint as array:

const app = new td.Application({
  // ...
  theme: 'default',
  includeDeclarations: true,
  entryPoint: ['babylon.d.ts']
});
app.generateDocs(['./babylon.d.ts'], config.target);

@bd82
Copy link

bd82 commented Feb 11, 2018

I think I managed to get it working use "--mode file" instead of --entryPoint

@Gerrit0 Gerrit0 closed this as completed Feb 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

5 participants