How should --polyglot mode control file extensions?

[ikokostya]

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)
{
}

[tmcw]

Thanks for the report. I'll be looking into this on Tuesday - most likely will have a response by then.

[tmcw]

Sorry for the delay, here's the deal:

node_modules/.bin/documentation build src -o build_doc.json --polyglot --format json --github
 --parseExtension=cpp

--polyglot does not, after beta.18, automatically add extensions that documentation.js parses. So --parseExtension=cpp adds 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:

• Parse everything in the directory, potentially stumbling on Markdown and image files and so on
• Have --polyglot automatically add --parseExtension=cpp --parseExtension=hpp, and hope that covers it? In this case, should --polyglot just be renamed --cpp instead?
• Another option?

--parseExtension should 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.

[ikokostya]

Combination of --polyglot --parseExtension=cpp options works as expected, thanks.

From my point of view there are two problems:

• --polyglot without --parseExtension does nothing. Maybe --polyglot option should require at least once --parseExtenstion option or print warning.
• This change isn't described in CHANGELOG.md and docs/POLYGLOT.md.