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

Second comment block #6

Closed
johnjacobkenny opened this issue Feb 2, 2017 · 8 comments
Closed

Second comment block #6

johnjacobkenny opened this issue Feb 2, 2017 · 8 comments

Comments

@johnjacobkenny
Copy link

From the readme,
A known issue: The comment block must be followed by another comment block for some reason (?)

Is this a typedoc issue or an issue with this plugin? Is there any info on any progress being made to solve it?

Thanks 😄

@jsdream
Copy link

jsdream commented Mar 2, 2017

+1

@filips-alpe
Copy link
Contributor

Looks like it comes from typedoc: https://github.com/TypeStrong/typedoc/blob/master/src/lib/converter/factories/comment.ts#L91-L93.
No idea why they're doing this but one of the options is reimplementing getRawComment in this repo. @christopherthielen I'd be happy to submit a PR if you think this would be the proper solution.

@christopherthielen
Copy link
Owner

christopherthielen commented Mar 28, 2017 via email

@filips-alpe
Copy link
Contributor

I considered submitting a PR to typedoc instead, however, it seems that they're intentionally doing this to avoid including stuff like license headers in the docs. PR coming up soon.

filips-alpe added a commit to filips-alpe/typedoc-plugin-external-module-name that referenced this issue Mar 29, 2017
Adapt `getRawComment` from `typedoc` to prevent skipping over the
topmost jsdoc block if only one such block is present.

Closes christopherthielen#6
filips-alpe added a commit to filips-alpe/typedoc-plugin-external-module-name that referenced this issue Mar 29, 2017
Adapt `getRawComment` from `typedoc` to prevent skipping over the
topmost jsdoc block if only one such block is present.

Closes christopherthielen#6
christopherthielen added a commit that referenced this issue Oct 27, 2017
@adrice727
Copy link

I'm still seeing this issue.

@christopherthielen
Copy link
Owner

@adrice727 can you post your repo? I'd like to take a look

@adrice727
Copy link

@christopherthielen It's currently private, but it should be public in another week or so.

christopherthielen added a commit that referenced this issue Feb 7, 2018
…r not requiring a second comment block."

This reverts commit a469ed4.
What was I thinking?

Fixes #6
@christopherthielen
Copy link
Owner

Released 1.1.1 which should correctly address this now. Sorry for the delay

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants