Skip to content

Commit 9625ee2

Browse files
tmcwtmcw
committed
style: Change dos line endings to unix
1 parent bc721c8 commit 9625ee2

File tree

13 files changed

+377
-385
lines changed

13 files changed

+377
-385
lines changed

Diff for: ‎LICENSE

+22-22
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
Copyright (c) 2015 André Fiedler
2-
3-
Permission is hereby granted, free of charge, to any person
4-
obtaining a copy of this software and associated documentation
5-
files (the "Software"), to deal in the Software without
6-
restriction, including without limitation the rights to use,
7-
copy, modify, merge, publish, distribute, sublicense, and/or sell
8-
copies of the Software, and to permit persons to whom the
9-
Software is furnished to do so, subject to the following
10-
conditions:
11-
12-
The above copyright notice and this permission notice shall be
13-
included in all copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17-
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20-
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21-
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22-
OTHER DEALINGS IN THE SOFTWARE.
1+
Copyright (c) 2015 André Fiedler
2+
3+
Permission is hereby granted, free of charge, to any person
4+
obtaining a copy of this software and associated documentation
5+
files (the "Software"), to deal in the Software without
6+
restriction, including without limitation the rights to use,
7+
copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the
9+
Software is furnished to do so, subject to the following
10+
conditions:
11+
12+
The above copyright notice and this permission notice shall be
13+
included in all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.

Diff for: ‎README.md

+116-116
Original file line numberDiff line numberDiff line change
@@ -1,116 +1,116 @@
1-
# grunt-documentation
2-
3-
[![Circle CI](https://circleci.com/gh/documentationjs/grunt-documentation/tree/master.svg?style=shield)](https://circleci.com/gh/documentationjs/grunt-documentation/tree/master)
4-
[![Greenkeeper badge](https://badges.greenkeeper.io/documentationjs/grunt-documentation.svg)](https://greenkeeper.io/)
5-
6-
Use [Grunt](http://gruntjs.com/) with
7-
[documentation](https://github.com/documentationjs/documentation)
8-
to generate great documentation for your JavaScript projects.
9-
10-
## Getting Started
11-
This plugin requires Grunt `>=0.4.0`
12-
13-
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
14-
15-
```shell
16-
npm install grunt-documentation --save-dev
17-
```
18-
19-
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
20-
21-
```js
22-
grunt.loadNpmTasks('grunt-documentation');
23-
```
24-
25-
## The "documentation" task
26-
27-
### Overview
28-
In your project's Gruntfile, add a section named `documentation` to the data object passed into `grunt.initConfig()`.
29-
30-
```js
31-
grunt.initConfig({
32-
documentation: {
33-
default: {
34-
files: [{
35-
"expand": true,
36-
"cwd": "src",
37-
"src": ["**/*.js"]
38-
}],
39-
options: {
40-
destination: "docs"
41-
}
42-
},
43-
}
44-
});
45-
```
46-
47-
### Options
48-
49-
#### options.destination
50-
Type: `String`
51-
52-
The destination folder for the generated docs.
53-
54-
#### options.format
55-
Type: `String`
56-
Default value: `'html'`
57-
58-
Either `'html'`, `'md'`, `'json'`, or `'docset'`.
59-
60-
#### options.filename
61-
Type: `String`
62-
63-
Custom filename for md or json output.
64-
65-
#### options.access
66-
Type: `Array`
67-
Default value: `['protected', 'public', 'undefined']`
68-
69-
Include only comments with a given access level, out of `private`, `protected`, `public` and `undefined`. By default, `public`, `protected` and `undefined` access levels are included.
70-
71-
#### options.order
72-
Type: `Array`
73-
Default value: `[]`
74-
75-
An array defining explicit sort order.
76-
77-
#### options.theme
78-
Type: `String`
79-
80-
Path to a custom theme.
81-
82-
#### options.name
83-
Type: `String`
84-
85-
A custom project name to display in the generated documentation.
86-
87-
#### options.version
88-
Type: `String`
89-
90-
A custom version string to display in the generated documentation.
91-
92-
## Contributing
93-
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint your code using [Grunt](http://gruntjs.com/).
94-
95-
## Release History
96-
97-
**v1.2.0**
98-
* new options: theme, name and version
99-
* now compatible with both 3.x and 4.x version of documentation
100-
* new theming demo
101-
102-
**v1.1.2**
103-
* always use latest NPM packages
104-
105-
**v1.1.1**
106-
* support Grunt 1.0
107-
108-
**v1.1.0**
109-
* new feature: `access` option to only include comments with a given access level, out of `private`, `protected`, `public` and `undefined`
110-
* new feature: `order` option to include user-defined sorting
111-
112-
**v1.0.1**
113-
* store `md` format at right destination; fixes [issue #3](https://github.com/documentationjs/grunt-documentation/issues/3)
114-
115-
**v1.0.0**
116-
* Transfered to documentationjs
1+
# grunt-documentation
2+
3+
[![Circle CI](https://circleci.com/gh/documentationjs/grunt-documentation/tree/master.svg?style=shield)](https://circleci.com/gh/documentationjs/grunt-documentation/tree/master)
4+
[![Greenkeeper badge](https://badges.greenkeeper.io/documentationjs/grunt-documentation.svg)](https://greenkeeper.io/)
5+
6+
Use [Grunt](http://gruntjs.com/) with
7+
[documentation](https://github.com/documentationjs/documentation)
8+
to generate great documentation for your JavaScript projects.
9+
10+
## Getting Started
11+
This plugin requires Grunt `>=0.4.0`
12+
13+
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
14+
15+
```shell
16+
npm install grunt-documentation --save-dev
17+
```
18+
19+
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
20+
21+
```js
22+
grunt.loadNpmTasks('grunt-documentation');
23+
```
24+
25+
## The "documentation" task
26+
27+
### Overview
28+
In your project's Gruntfile, add a section named `documentation` to the data object passed into `grunt.initConfig()`.
29+
30+
```js
31+
grunt.initConfig({
32+
documentation: {
33+
default: {
34+
files: [{
35+
"expand": true,
36+
"cwd": "src",
37+
"src": ["**/*.js"]
38+
}],
39+
options: {
40+
destination: "docs"
41+
}
42+
},
43+
}
44+
});
45+
```
46+
47+
### Options
48+
49+
#### options.destination
50+
Type: `String`
51+
52+
The destination folder for the generated docs.
53+
54+
#### options.format
55+
Type: `String`
56+
Default value: `'html'`
57+
58+
Either `'html'`, `'md'`, `'json'`, or `'docset'`.
59+
60+
#### options.filename
61+
Type: `String`
62+
63+
Custom filename for md or json output.
64+
65+
#### options.access
66+
Type: `Array`
67+
Default value: `['protected', 'public', 'undefined']`
68+
69+
Include only comments with a given access level, out of `private`, `protected`, `public` and `undefined`. By default, `public`, `protected` and `undefined` access levels are included.
70+
71+
#### options.order
72+
Type: `Array`
73+
Default value: `[]`
74+
75+
An array defining explicit sort order.
76+
77+
#### options.theme
78+
Type: `String`
79+
80+
Path to a custom theme.
81+
82+
#### options.name
83+
Type: `String`
84+
85+
A custom project name to display in the generated documentation.
86+
87+
#### options.version
88+
Type: `String`
89+
90+
A custom version string to display in the generated documentation.
91+
92+
## Contributing
93+
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint your code using [Grunt](http://gruntjs.com/).
94+
95+
## Release History
96+
97+
**v1.2.0**
98+
* new options: theme, name and version
99+
* now compatible with both 3.x and 4.x version of documentation
100+
* new theming demo
101+
102+
**v1.1.2**
103+
* always use latest NPM packages
104+
105+
**v1.1.1**
106+
* support Grunt 1.0
107+
108+
**v1.1.0**
109+
* new feature: `access` option to only include comments with a given access level, out of `private`, `protected`, `public` and `undefined`
110+
* new feature: `order` option to include user-defined sorting
111+
112+
**v1.0.1**
113+
* store `md` format at right destination; fixes [issue #3](https://github.com/documentationjs/grunt-documentation/issues/3)
114+
115+
**v1.0.0**
116+
* Transfered to documentationjs

Diff for: ‎demo/html/Gruntfile.js

+33-35
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,33 @@
1-
/*
2-
* grunt-documentation demo
3-
*
4-
* Copyright (c) 2015 André Fiedler
5-
* Licensed under the MIT license.
6-
*/
7-
'use strict';
8-
9-
module.exports = function(grunt) {
10-
11-
// Project configuration.
12-
grunt.initConfig({
13-
14-
documentation: {
15-
default: {
16-
files: [{
17-
'expand': true,
18-
'cwd': 'src',
19-
'src': ['**/*.js']
20-
}],
21-
options: {
22-
destination: 'docs'
23-
}
24-
},
25-
}
26-
27-
});
28-
29-
// Actually load this plugin's task(s).
30-
grunt.loadTasks('../../tasks');
31-
32-
// By default, run.
33-
grunt.registerTask('default', ['documentation']);
34-
35-
};
1+
/*
2+
* grunt-documentation demo
3+
*
4+
* Copyright (c) 2015 André Fiedler
5+
* Licensed under the MIT license.
6+
*/
7+
'use strict';
8+
9+
module.exports = function(grunt) {
10+
// Project configuration.
11+
grunt.initConfig({
12+
documentation: {
13+
default: {
14+
files: [
15+
{
16+
expand: true,
17+
cwd: 'src',
18+
src: ['**/*.js']
19+
}
20+
],
21+
options: {
22+
destination: 'docs'
23+
}
24+
}
25+
}
26+
});
27+
28+
// Actually load this plugin's task(s).
29+
grunt.loadTasks('../../tasks');
30+
31+
// By default, run.
32+
grunt.registerTask('default', ['documentation']);
33+
};

0 commit comments

Comments
 (0)