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.

Sign up for GitHub

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

Jump to bottom

Remove polyglot mode #850

Closed
tmcw opened this issue Jul 27, 2017 · 0 comments
Closed

Remove polyglot mode #850

tmcw opened this issue Jul 27, 2017 · 0 comments
Milestone
5.0.0

Comments

@tmcw
Copy link
Member

tmcw commented Jul 27, 2017

This will invalidate #731 #702 and #132 and address part of #800

The gist of the plan is

  • polyglot mode is cool! but it's not the main usecase of documentation and has some real drawbacks
    • the code it uses to parse comments, get-comments, is unmaintained and has a critical bug
    • it interferes with the logic of our file extension getting and makes that process confusing

I'd like to still support C++ and other languages in the future! But I'm much happier doing so by separating the extraction & input phases to the degree that documentation.js can read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP support in it.
@tmcw tmcw added this to the 5.0.0 milestone Jul 27, 2017
tmcw added a commit that referenced this issue Jul 27, 2017
@tmcw
revert(polyglot): Remove polyglot mode
3ba5ffe 
BREAKING CHANGE: I'd like to still support C++ and other languages in the future! But I'm much
happier doing so by separating the extraction & input phases to the degree that documentation.js can
read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP
support in it.

Fixes #850. Fixes #731. Fixes #702. Fixes #132.
@tmcw tmcw mentioned this issue Jul 27, 2017
Merged
tmcw added a commit that referenced this issue Jul 27, 2017
@tmcw
revert(polyglot): Remove polyglot mode
7b982ea 
BREAKING CHANGE: I'd like to still support C++ and other languages in the future! But I'm much
happier doing so by separating the extraction & input phases to the degree that documentation.js can
read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP
support in it.

Fixes #850. Fixes #731. Fixes #702. Fixes #132.
@tmcw tmcw closed this as completed in #851 Jul 27, 2017
tmcw added a commit that referenced this issue Jul 27, 2017
@tmcw
revert(polyglot): Remove polyglot mode
5b373ff 
BREAKING CHANGE: I'd like to still support C++ and other languages in the future! But I'm much
happier doing so by separating the extraction & input phases to the degree that documentation.js can
read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP
support in it.

Fixes #850. Fixes #731. Fixes #702. Fixes #132.
@tmcw tmcw mentioned this issue Jul 27, 2017
Closed
@springmeyer springmeyer mentioned this issue Jul 14, 2018
Open
2 tasks
springmeyer pushed a commit to mapbox/node-cpp-skel that referenced this issue Jul 14, 2018
pin to documentation@4.x in readme - refs documentationjs/documentati…
f9fa032 
…on#850 #150
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
5.0.0
Development

No branches or pull requests
1 participant
@tmcw