# @daybrush/jsdoc

> An API documentation generator for JavaScript and Typescript.

Latest version **0.4.7** (published 2023-01-28) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @daybrush/jsdoc
pnpm add @daybrush/jsdoc
yarn add @daybrush/jsdoc
bun add @daybrush/jsdoc
```

Provides the command `jsdoc`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.7 |
| Published | 2023-01-28 |
| First published | 2018-08-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.2.0 |
| Dependencies | 17 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 (+8 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Michael Mathews |
| Maintainers | younkue |
| Keywords | documentation, javascript, typescript, tsdoc, jsdoc, typedoc, ast |

## Links

- npm: https://www.npmjs.com/package/@daybrush/jsdoc
- Repository: https://github.com/daybrush/jsdoc
- Homepage: https://github.com/daybrush/jsdoc#readme
- Issues: https://github.com/daybrush/jsdoc/issues
- npm.io page: https://npm.io/package/@daybrush/jsdoc

## Dependencies (17)

- [klaw](https://npm.io/package/klaw.md) ~2.0.0
- [marked](https://npm.io/package/marked.md) ~0.3.6
- [mkdirp](https://npm.io/package/mkdirp.md) ~0.5.1
- [taffydb](https://npm.io/package/taffydb.md) 2.6.2
- [bluebird](https://npm.io/package/bluebird.md) ~3.5.0
- [catharsis](https://npm.io/package/catharsis.md) ~0.8.9
- [requizzle](https://npm.io/package/requizzle.md) ~0.2.1
- [ast-parser](https://npm.io/package/ast-parser.md) ^0.2.0
- [underscore](https://npm.io/package/underscore.md) ~1.8.3
- [markdown-it](https://npm.io/package/markdown-it.md) ~8.3.1
- [@babel/types](https://npm.io/package/@babel/types.md) ^7.2.2
- [js2xmlparser](https://npm.io/package/js2xmlparser.md) ~3.0.0
- [@babel/parser](https://npm.io/package/@babel/parser.md) ^7.2.3
- [@daybrush/utils](https://npm.io/package/@daybrush/utils.md) ^1.6.0
- [strip-json-comments](https://npm.io/package/strip-json-comments.md) ~2.0.1
- [escape-string-regexp](https://npm.io/package/escape-string-regexp.md) ~1.0.5
- [markdown-it-named-headers](https://npm.io/package/markdown-it-named-headers.md) ~0.0.4

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 0.4.7 (latest) — 2023-01-28
- 0.4.6 — 2023-01-28
- 0.4.5 — 2023-01-04
- 0.4.4 — 2022-12-30
- 0.4.3 — 2022-08-31
- 0.4.2 — 2022-08-31
- 0.4.1 — 2022-05-13
- 0.4.0 — 2022-04-14
- 0.3.12 — 2022-01-11
- 0.3.11 — 2021-09-07
- 0.3.10 — 2021-02-03
- 0.3.9 — 2021-01-10
- 0.3.8 — 2020-09-03
- 0.3.7 — 2019-03-19
- 0.3.7-rc3 — 2019-03-14
- … 31 more at https://npm.io/package/@daybrush/jsdoc/versions

## README

@daybrush/jsdoc [![npm version](https://badge.fury.io/js/%40daybrush%2Fjsdoc.svg)](https://badge.fury.io/js/%40daybrush%2Fjsdoc)
=======

```bash
npm install --save-dev @daybrush/jsdoc
```

## Support Typescript from version 0.3.0
* [Scene.js Typescript API Documentation](https://daybrush.com/scenejs/release/latest/doc/index.html)
* [@daybrush/utils Typescript API Documentation](https://daybrush.com/utils/release/latest/doc/index.html)
* [InfiniteGrid Typescript API Documentation](https://naver.github.io/egjs-infinitegrid/release/latest/doc/)

### ```name``` and ```type``` can be omitted in function and method
* jsdoc
```ts
/**
 */
function a(a: Parameter1, b: Parameter2): ReturnType {
}
```
* result

![](./images/function-result.png)
---

### ```extends``` and ```implements``` can be omitted from the class.
* jsdoc

```ts
/**
*/
export class A extends B implements a {
}
```

* result


![](./images/class-result.png)

---

### Supports type declaration
* jsdoc
```ts
/**
 * @typedef
 */
export type a<T> = () => T;
```

* result

![](./images/type-result.png)

---
### Supports interface declaration

* jsdoc
```ts
/**
 * @typedef
 */
export interface a {
    a: string;
    b: number;
    c: () => void;
    d(a: string, b: number): void;
    (a: string, b: number): void;
    [key: string]: any;
}
```

* result


![](./images/interface-result.png)

---


### jsdoc.json (Add ts extension to includePattern)
```json
{
    "source": {
        "includePattern": ".+\\.(j|t)s(doc|x)?$",
    },
}
```


JSDoc 3
=======

[![Build Status](https://travis-ci.org/jsdoc3/jsdoc.svg?branch=master)](http://travis-ci.org/jsdoc3/jsdoc)

An API documentation generator for JavaScript.

Want to contribute to JSDoc? Please read `CONTRIBUTING.md`.

Installation and Usage
----------------------

JSDoc supports Node.js 4.2.0 and later. You can install JSDoc globally or in your project's
`node_modules` folder.

To install the latest version on npm globally (may require `sudo`; [learn how to fix
this](https://docs.npmjs.com/getting-started/fixing-npm-permissions)):

    npm install -g jsdoc

To install the latest version on npm locally and save it in your package's `package.json` file:

    npm install --save-dev jsdoc

**Note**: By default, npm adds your package using the caret operator in front of the version number
(for example, `^3.5.2`). We recommend using the tilde operator instead (for example, `~3.5.2`),
which limits updates to the most recent patch-level version. See [this Stack Overflow
answer](https://stackoverflow.com/questions/22343224) for more information about the caret and tilde
operators.

To install the latest development version locally, without updating your project's `package.json`
file:

    npm install git+https://github.com/jsdoc3/jsdoc.git

If you installed JSDoc locally, the JSDoc command-line tool is available in `./node_modules/.bin`.
To generate documentation for the file `yourJavaScriptFile.js`:

    ./node_modules/.bin/jsdoc yourJavaScriptFile.js

Or if you installed JSDoc globally, simply run the `jsdoc` command:

    jsdoc yourJavaScriptFile.js

By default, the generated documentation is saved in a directory named `out`. You can use the
`--destination` (`-d`) option to specify another directory.

Run `jsdoc --help` for a complete list of command-line options.

Templates and Tools
-------------------

The JSDoc community has created numerous templates and other tools to help you generate and
customize your documentation. Here are just a few:

### Templates

+ [jaguarjs-jsdoc](https://github.com/davidshimjs/jaguarjs-jsdoc)
+ [DocStrap](https://github.com/docstrap/docstrap) ([example](https://docstrap.github.io/docstrap))
+ [jsdoc3Template](https://github.com/DBCDK/jsdoc3Template)
  ([example](https://github.com/danyg/jsdoc3Template/wiki#wiki-screenshots))
+ [minami](https://github.com/Nijikokun/minami)
+ [docdash](https://github.com/clenemt/docdash) ([example](http://clenemt.github.io/docdash/))
+ [tui-jsdoc-template](https://github.com/nhnent/tui.jsdoc-template) ([example](https://nhnent.github.io/tui.jsdoc-template/latest/))

### Build Tools

+ [JSDoc Grunt plugin](https://github.com/krampstudio/grunt-jsdoc)
+ [JSDoc Gulp plugin](https://github.com/mlucool/gulp-jsdoc3)

### Other Tools

+ [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown)
+ [Integrating GitBook with
JSDoc](https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3)

For More Information
--------------------

+ Documentation is available at [Use JSDoc](http://usejsdoc.org).
+ Contribute to the docs at [jsdoc3/jsdoc3.github.com](https://github.com/jsdoc3/jsdoc3.github.com).
+ [Join JSDoc's Slack channel](https://jsdoc-slack.appspot.com/).
+ Ask for help on the [JSDoc Users mailing list](http://groups.google.com/group/jsdoc-users).
+ Post questions tagged `jsdoc` to [Stack
Overflow](http://stackoverflow.com/questions/tagged/jsdoc).

License
-------

JSDoc 3 is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and the [contributors to
JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).

JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file `LICENSE.md`
in this distribution for more details.

---
_Source: https://npm.io/package/@daybrush/jsdoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._