npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

documentation-polyglot

v1.0.1

Published

C++ plugin for documentation.js

Downloads

86

Readme

documentation-polyglot.js

When good engineers meet, they discuss algorithms, but when great engineers meet, they discuss documentation

License: ISC Node.js CI codecov

Plugin Notes

This plugin restores the C++ support for documentation.js.

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.

Installation

The module is not yet published

npm install -D documentation-polyglot

Usage

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

project-documentation.yml:

toc:
  - Project Headline

plugin:
  - documentation-polyglot

documentation-polyglot:
  extensions: [ .cpp ]

Extracting information from C++ code

An example for extracting names of Node::Nan methods

documentation-polyglot:
  extensions: [ .cpp ]
  infer:
    kind:
      function: [ NAN_METHOD\(.*\) ]
    name: [ NAN_METHOD\s*\((.*)\) ]

An 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