Skip to content

Releases: klmhyeonwoo/jsdoc-builder

v0.0.6

15 Feb 05:51
3fb25a0
Compare
Choose a tag to compare

What's Changed

  • fix: #2 Add logic that does not apply to functions for which jsdoc al… by @klmhyeonwoo in #3

New Contributors

Full Changelog: v0.0.5...v0.0.6

v0.0.5

22 Jan 10:52
Compare
Choose a tag to compare

Full Changelog: v0.0.3...v0.0.4

v0.0.4

22 Jan 10:42
Compare
Choose a tag to compare

Full Changelog: v0.0.3...v0.0.4

v0.0.3

22 Jan 10:40
Compare
Choose a tag to compare
feat: update v0.0.3

v0.0.1

19 Jan 15:40
Compare
Choose a tag to compare

Features

Automatic JSDoc Generation:

  • Automatically generates JSDoc comments for functions and variables in JavaScript and TypeScript files.
  • Supports function declarations, arrow functions, and TypeScript types and interfaces.
  • Infers parameter and return types directly from TypeScript annotations to ensure accurate JSDoc comments.

Simple CLI Usage:

  • Process files with an easy command: jsdoc-builder .
  • No additional subcommands required—just specify the file path, and JSDoc comments will be inserted.
  • Structured Output:
    • Generates clean and well-structured JSDoc comments for improved code documentation.
/**
 * @description Function description
 * @param {number} a
 * @param {number} b
 * @returns {number}
 * */
function add(a: number, b: number) {
  return a + b;
}

Installation

  • Install globally with npm install jsdoc-builder -g.
  • Install locally as a dev dependency with npm install jsdoc-builder --save-dev.
jsdoc-builder example.ts

Stay tuned for new features and improvements in upcoming releases.

Full Changelog: https://github.com/klmhyeonwoo/jsdoc-generator/commits/0.0.1

v0.0.2

22 Jan 10:29
Compare
Choose a tag to compare
fix: generate logic