Repository navigation
How should --polyglot mode control file extensions? #702
Description
After upgrade from 4.0.0-beta.17 to 4.0.0-beta.18 documentation for C++ nodejs addon is not generated anymore. For generating I use the following command:
node_modules/.bin/documentation build src -o build_doc.json --polyglot --format json --github
where src is a directory with C++ code, e.g.
// src/test.cpp
/**
* @function foo
*/
NAN_METHOD(foo)
{
}
Activity
tmcw commentedon Mar 31, 2017
Thanks for the report. I'll be looking into this on Tuesday - most likely will have a response by then.
tmcw commentedon Apr 24, 2017
Sorry for the delay, here's the deal:
--polyglotdoes not, after beta.18, automatically add extensions that documentation.js parses. So--parseExtension=cppadds cpp to one of the extensions that documentation.js treats as parseable and looks for.I'm not 100% confident about this design, but unfortunately none of the options are all that great:
We could:
--polyglotautomatically add--parseExtension=cpp --parseExtension=hpp, and hope that covers it? In this case, should--polyglotjust be renamed--cppinstead?--parseExtensionshould solve this issue for you - if it doesn't, let me know. I'll keep this issue open for a while to see if anyone has ideas/opinions that might steer us in the right direction.[-]Version 4.0.0-beta.18 doesn't generate documentation for c++[/-][+]How should --polyglot mode control file extensions?[/+]ikokostya commentedon Apr 24, 2017
Combination of
--polyglot --parseExtension=cppoptions works as expected, thanks.From my point of view there are two problems:
--polyglotwithout--parseExtensiondoes nothing. Maybe--polyglotoption should require at least once--parseExtenstionoption or print warning.revert(polyglot): Remove polyglot mode
revert(polyglot): Remove polyglot mode
revert(polyglot): Remove polyglot mode