javadoc-brute

Extracts javadoc-like comments and puts them together.

Installation

npm install -s @allnulled/javadoc-brute

Usage

You can use it by API or command line.

Command line usage

npx javadoc-brute
  --include "glob/path/**/*.js"
  --exclude "node_modules/**/*.js"
  --output "REFERENCE.md"

API usage

const JavadocBrute = require("@allnulled/javadoc-brute");

await JavadocBrute.extractComments({
  include: ["glob/path/**/*.js"],
  exclude: ["node_modules/**/*.js"],
  output: "output.md"
});

Example

/**
 * 
 * Esto es un ejemplo que sí será captado como javadoc comment.
 * 
 */

/*
 * 
 * Esto no será captado.
 * 
 */