# ape-doc

> Doc parser of ape.

Latest version **2.0.4** (published 2016-07-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install ape-doc
pnpm add ape-doc
yarn add ape-doc
bun add ape-doc
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.4 |
| Published | 2016-07-12 |
| First published | 2016-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | ape, doc |

## Links

- npm: https://www.npmjs.com/package/ape-doc
- Repository: https://github.com/ape-repo/ape-doc
- Homepage: https://github.com/ape-repo/ape-doc#readme
- Issues: https://github.com/ape-repo/ape-doc/issues
- npm.io page: https://npm.io/package/ape-doc

## Dependencies (5)

- [aglob](https://npm.io/package/aglob.md) ^1.0.1
- [execcli](https://npm.io/package/execcli.md) ^4.0.6
- [stringcase](https://npm.io/package/stringcase.md) ^3.0.1
- [react-docgen](https://npm.io/package/react-docgen.md) ^2.9.1
- [comment-parser](https://npm.io/package/comment-parser.md) ^0.4.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 2.0.4 (latest) — 2016-07-12
- 2.0.3 — 2016-06-30
- 2.0.2 — 2016-06-26
- 2.0.1 — 2016-06-26
- 2.0.0 — 2016-05-21
- 1.1.3 — 2016-04-21
- 1.1.2 — 2016-04-20
- 1.1.1 — 2016-04-20
- 1.1.0 — 2016-04-20
- 1.0.5 — 2016-04-20
- 1.0.4 — 2016-04-11
- 1.0.3 — 2016-04-11
- 1.0.2 — 2016-04-11

## README

ape-doc
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/ape-repo/ape-doc
[bd_travis_url]: http://travis-ci.org/ape-repo/ape-doc
[bd_travis_shield_url]: http://img.shields.io/travis/ape-repo/ape-doc.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/ape-repo/ape-doc
[bd_travis_com_shield_url]: https://api.travis-ci.com/ape-repo/ape-doc.svg?token=
[bd_license_url]: https://github.com/ape-repo/ape-doc/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/ape-repo/ape-doc
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/ape-repo/ape-doc.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/ape-repo/ape-doc.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/ape-repo/ape-doc
[bd_gemnasium_shield_url]: https://gemnasium.com/ape-repo/ape-doc.svg
[bd_npm_url]: http://www.npmjs.org/package/ape-doc
[bd_npm_shield_url]: http://img.shields.io/npm/v/ape-doc.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Doc parser of ape.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>
Installation
-----

```bash
$ npm install ape-doc --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>
Usage
---------

```javascript
'use strict';

const apeDoc = require('ape-doc');

// Javascript file path to read.
let FILE_PATH = require.resolve('ape-doc/lib/comments_in_file');
let comments = apeDoc(
  FILE_PATH
)
assert.deepEqual(comments, [
  {
    'line': 0,
    'description': 'Extract comments from a file.',
    'function': [
      {
        'name': 'commentsInFile',
        'optional': false,
        'type': '',
        'description': '',
        'line': 2,
        'source': '@function commentsInFile'
      }
    ],
    'param': [
      {
        'type': 'string',
        'name': 'filename',
        'optional': false,
        'description': '- Filename to read.',
        'line': 3,
        'source': '@param {string} filename - Filename to read.'
      }
    ],
    'returns': [
      {
        'type': 'Object[]',
        'name': '',
        'optional': false,
        'description': '',
        'line': 4,
        'source': '@returns {Object[]}'
      }
    ]
  },
  {
    'line': 11,
    'description': '',
    'lends': [
      {
        'name': 'commentsInFile',
        'optional': false,
        'type': '',
        'description': '',
        'line': 11,
        'source': '@lends commentsInFile'
      }
    ]
  }
])

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/ape-repo/ape-doc/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------



<!-- Links End -->

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