<commit_before># grunt-jsduck

Grunt task to compile [JSDuck](https://github.com/senchalabs/jsduck) documentation


## Getting Started

### Installation

At the moment the task works with either Grunt `~0.4.0` or `~0.3.0`.

You need to have Ruby and JSDuck installed. Refer to project homepage for installation instructions.

Install this grunt plugin next to your project's [grunt.js gruntfile](http://gruntjs.com/getting-started) with: `npm install grunt-jsduck`

Then add this line to your project's `grunt.js` gruntfile:

```javascript
grunt.loadNpmTasks('grunt-jsduck');
```

### Configuration

Inside your `grunt.js` file add a section named `jsduck`.
Read the [JSDuck Guide](https://github.com/senchalabs/jsduck/wiki/Guide) for an overview of its features.

#### src

Input directories containing JavaScript code to document.

#### dest

Output directory for generated documentation.

#### options

Additional options that will be passed to jsduck.  Run `jsduck --help` for a full list.


### Example configuration

```javascript
jsduck: {
    main: {
        // source paths with your code
        src: [
            'ext-4.1.1/src',
            'project1/js',
            'project2/js'
        ],

        // docs output dir
        dest: 'docs',

        // extra options
        options: {
            'builtin-classes': true,
            'warnings': ['-no_doc', '-dup_member', '-link_ambiguous'],
            'external': ['XMLHttpRequest']
        }
    }<commit_msg>Updated README to reflect changes in the new version<commit_after># grunt-jsduck

Grunt task to compile [JSDuck](https://github.com/senchalabs/jsduck) documentation


## Getting Started

### Installation

**WARNING!** Starting from version `1.0.0`, the task is incompatible with Grunt `0.3`.
Use the legacy `0.1.x` version you still use Grunt `0.3`.

You need to have Ruby and JSDuck installed. Refer to project homepage for installation instructions.

Install this grunt plugin next to your project's [grunt.js gruntfile](http://gruntjs.com/getting-started) with: `npm install grunt-jsduck`

Then add this line to your project's `grunt.js` gruntfile:

```javascript
grunt.loadNpmTasks('grunt-jsduck');
```

### Configuration

Inside your `grunt.js` file add a section named `jsduck`.
Read the [JSDuck Guide](https://github.com/senchalabs/jsduck/wiki/Guide) for an overview of its features.

#### src

Input paths containing JavaScript code to document. You can use wildcards here (see example below).

#### dest

Output directory for generated documentation.

#### options

Additional options that will be passed to jsduck.  Run `jsduck --help` for a full list.


### Example configuration

```javascript
jsduck: {
    main: {
        // source paths with your code
        src: [
            'ext-4.1.1/src',
            'project1/js',
            'project2/**/*.js'  // globbing supported!
        ],

        // docs output dir
        dest: 'docs',

        // extra options
        options: {
            'builtin-classes': true,
            'warnings': ['-no_doc', '-dup_member', '-link_ambiguous'],
            'external': ['XMLHttpRequest']
        }
    }
{'fraction_non_alphanumeric': 0.12150127226463105, 'fraction_numerical': 0.007951653944020356, 'mean_word_length': 2.916562889165629, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5841463', 'n_tokens_mistral': 972, 'n_tokens_neox': 934, 'n_words': 314}