When good engineers meet, they discuss algorithms, but when great engineers meet, they discuss documentation
This plugin restores the C++ support for
It requires a plugin framework in
documentation.js that has yet to be merged. You can install it from here:
npm install -D @mmomtchev/documentation
It is an improved version of the old
--polyglot CLI option of
documentation.js that got axed in 2017.
The project should already be usable.
It uses dumb parsing without an AST blindly extracting JSDoc-compliant comment blocks.
I intend to add extensible helpers allowing to extract some (C++ is notoriously difficult to parse and this aims to be an universal extractor anyways) information from the C++ code.
The module is not yet published
npm install -D documentation-polyglot
Note that enabling
documentation-polyglot will also enable
--shallow if this is not already the case.
Loading via the command-line
documentation build --plugin=documentation-polyglot src/*.cpp lib/*.js -f md -o project.md
Loading via a configuration file
documentation build --config=project-documentation.yml src/*.cpp lib/*.js -f md -o project.md
toc: - Project Headline plugin: - documentation-polyglot documentation-polyglot: extensions: [ .cpp ]
Extracting information from C++ code
An example for extracting names of
documentation-polyglot: extensions: [ .cpp ] infer: kind: function: [ NAN_METHOD\(.*\) ] name: [ NAN_METHOD\s*\((.*)\) ]
infer section applies an implicit JSDoc tag to the tag having the section name:
- with subsections it will apply the subsection name when one of the provided REs matches.
- with only REs it will apply the first capture group