-
Notifications
You must be signed in to change notification settings - Fork 481
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
revert(polyglot): Remove polyglot mode
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.
- Loading branch information
Showing
15 changed files
with
37 additions
and
1,101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
5b373ff
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tmcw I forked documentationjs and I restored
polyglot
(the merge was surprisingly easy 4 years later)I intend to use this fork to document my project
gdal-async
which is a Node.js addon where a majority of the JS classes are backed by C++ implementationsI cannot stress enough the importance of this project since yuidoc, the only other documentation solution that supports both jsdoc and C++ is not maintained since 2016
Doxygen and sphinx are not native JS documentation generators and lack many features - Node.js addons are a very special kind of projects - they are JS projects written in C++
I have lots of spare time on my hands and I need this project, so:
5b373ff
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @mmomtchev! Thanks for your work on gdal-async, it's very cool :) @anthony-redFox is really the one maintaining documentation.js nowadays, he'd be the best person to ask about whether reintroducing this to the project would be feasible!
5b373ff
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tmcw, ok thanks a lot for your response, and of course glad to hear that
gdal-async
is usefulgdal-async
is a complex project and once I am able to produce a quality documentation withdocument
, I will consider my work complete and then we will discuss what could be done with this new parser