Skip to content

Commit

Permalink
huge whitespace cleanup
Browse files Browse the repository at this point in the history
- remove all trailing whitespace
- for consistency, replace all tabs with spaces
  • Loading branch information
hegemonic committed Mar 3, 2014
1 parent 0a05ede commit 48e6c39
Show file tree
Hide file tree
Showing 127 changed files with 601 additions and 719 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,47 +11,47 @@ ones.
1. **Create a remote to track the base jsdoc3/jsdoc repository**
This is just a convenience to make it easier to update your ```<tracking branch>```
(more on that shortly). You would execute something like:

git remote add base git://github.com/jsdoc3/jsdoc.git

Here 'base' is the name of the remote. Feel free to use whatever you want.

2. **Set up a tracking branch for the base repository**
We're gonna call this your ```<tracking branch>```. You will only ever update
this branch by pulling from the 'base' remote. (as opposed to 'origin')

git branch --track pullpost base/master
git checkout pullpost

Here 'pullpost' is the name of the branch. Fell free to use whatever you want.

3. **Create your change branch**
Once you are in ```<tracking branch>```, make sure it's up to date, then create
a branch for your changes off of that one.

git branch fix-for-issue-395
git checkout fix-for-issue-395

Here 'fix-for-issue-395' is the name of the branch. Feel free to use whatever
you want. We'll call this the ```<change branch>```. This is the branch that
you will eventually issue your pull request from.

The purpose of these first three steps is to make sure that your merge request
has a nice clean diff that only involves the changes related to your fix/feature.

4. **Make your changes**
On your ```<change branch>``` make any changes relevant to your fix/feature. Don't
group fixes for multiple unrelated issues or multiple unrelated features together.
Create a separate branch for each unrelated changeset. For instance, if you're
fixing a bug in the parser and adding some new UI to the default template, those
should be separate branches and merge requests.

5. **Add tests**
Add tests for your change. If you are submitting a bugfix, include a test that
verifies the existence of the bug along with your fix. If you are submitting
a new feature, include tests that verify proper feature function, if applicable.
See the readme in the 'test' directory for more information

6. **Commit and publish**
Commit your changes and publish your branch (or push it if it's already published)

Expand All @@ -62,7 +62,7 @@ ones.
situations that bug occurs in and a sense of it's severity. If it does already have
an issue, make sure the include the hash and issue number (e.g. '#100') so github
links it.

If it's a feature, provide some context about the motivations behind the feature,
why it's important/useful/cool/necessary and what it does/how it works. Don't
worry about being too verbose. Folks will be much more amenable to reading through
Expand Down
21 changes: 0 additions & 21 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ As stated in Section 7, "Disclaimer of Warranty," of the License:
The source code for JSDoc 3 is available at:
https://github.com/jsdoc3/jsdoc


# Third-Party Software #

JSDoc 3 includes or depends upon the following third-party software, either in
Expand Down Expand Up @@ -55,7 +54,6 @@ license, which is reproduced below:
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.

## Acorn ##

Portions of the Acorn source code are incorporated into the following files:
Expand All @@ -69,7 +67,6 @@ Copyright (C) 2012 Marijn Haverbeke <[email protected]>.
The source code for Acorn is available at:
https://github.com/marijnh/acorn


## Async.js ##

Async.js is distributed under the MIT license, which is reproduced above.
Expand All @@ -79,7 +76,6 @@ Copyright (c) 2010 Caolan McMahon.
The source code for Async.js is available at:
https://github.com/caolan/async


## Catharsis ##

Catharsis is distributed under the MIT license, which is reproduced above.
Expand All @@ -89,7 +85,6 @@ Copyright (c) 2012-2013 Jeff Williams.
The source code for Catharsis is available at:
https://github.com/hegemonic/catharsis


## crypto-browserify ##

crypto-browserify is distributed under the MIT license, which is reproduced
Expand All @@ -100,7 +95,6 @@ Copyright (c) 2013 Dominic Tarr.
The source code for crypto-browserify is available at:
https://github.com/dominictarr/crypto-browserify


## Esprima ##

Esprima is distributed under the BSD 2-clause license:
Expand Down Expand Up @@ -130,7 +124,6 @@ Copyright (c) 2011-2013 Ariya Hidayat and other Esprima contributors.
The source code for Esprima is available at:
https://github.com/ariya/esprima


## github-flavored-markdown ##

github-flavored-markdown is distributed under the BSD 3-clause license:
Expand Down Expand Up @@ -169,7 +162,6 @@ github-flavored-markdown is distributed under the BSD 3-clause license:
The source code for github-flavored-markdown is available at:
https://github.com/hegemonic/github-flavored-markdown


## Google Code Prettify ##

Google Code Prettify is distributed under the Apache License 2.0, which is
Expand All @@ -180,7 +172,6 @@ Copyright (c) 2006 Google Inc.
The source code for Google Code Prettify is available at:
https://code.google.com/p/google-code-prettify/


## Jasmine ##

Jasmine is distributed under the MIT license, which is reproduced above.
Expand All @@ -190,7 +181,6 @@ Copyright (c) 2008-2011 Pivotal Labs.
The source code for Jasmine is available at:
https://github.com/pivotal/jasmine


## jasmine-node ##

jasmine-node is distributed under the MIT license, which is reproduced above.
Expand All @@ -200,7 +190,6 @@ Copyright (c) 2010 Adam Abrons and Misko Hevery (http://getangular.com).
The source code for jasmine-node is available at:
https://github.com/mhevery/jasmine-node


## js2xmlparser ##

js2xmlparser is distributed under the MIT license, which is reproduced above.
Expand All @@ -210,7 +199,6 @@ Copyright (c) 2012 Michael Kourlas.
The source code for js2xmlparser is available at:
https://github.com/michaelkourlas/node-js2xmlparser


## JSHint ##

JSHint is distributed under the MIT license, which is reproduced above.
Expand Down Expand Up @@ -243,7 +231,6 @@ modified MIT license:
The source code for JSHint is available at:
https://github.com/jshint/jshint


## Node.js ##

Portions of the Node.js source code are incorporated into the following files:
Expand All @@ -260,7 +247,6 @@ Copyright Joyent, Inc. and other Node contributors. All rights reserved.
The source code for Node.js is available at:
https://github.com/joyent/node


## node-browser-builtins ##

Portions of the node-browser-builtins source code are incorporated into the
Expand All @@ -275,7 +261,6 @@ above.
The source code for node-browser-builtins is available at:
https://github.com/alexgorbatchev/node-browser-builtins


## node-browserify ##

Portions of the node-browserify source code are incorporated into the following
Expand All @@ -288,7 +273,6 @@ node-browserify is distributed under the MIT license, which is reproduced above.
The source code for node-browserify is available at:
https://github.com/substack/node-browserify


## Rhino ##

Rhino is distributed under the following licenses:
Expand Down Expand Up @@ -329,7 +313,6 @@ Additionally, some files are available under the BSD 3-clause license:
The source code for Rhino is available at:
https://github.com/jsdoc3/rhino


## TaffyDB ##

TaffyDB is distributed under a modified BSD license:
Expand Down Expand Up @@ -358,7 +341,6 @@ TaffyDB is distributed under a modified BSD license:
The source code for TaffyDB is available at:
https://github.com/hegemonic/taffydb


## Tomorrow Theme for Google Code Prettify ##

License information for the Tomorrow Theme for Google Code Prettify is not
Expand All @@ -370,7 +352,6 @@ Copyright (c) Yoshihide Jimbo.
The source code for the Tomorrow Theme is available at:
https://github.com/jmblog/color-themes-for-google-code-prettify


## tv4 ##

tv4 is in the public domain. It is also distributed under the MIT license, which
Expand All @@ -379,7 +360,6 @@ is reproduced above.
The source code for tv4 is available at:
https://github.com/geraintluff/tv4


## Underscore.js ##

Underscore.js is distributed under the MIT license, which is reproduced above.
Expand All @@ -389,7 +369,6 @@ Copyright (c) 2009-2012 Jeremy Ashkenas, DocumentCloud.
The source code for Underscore.js is available at:
https://github.com/documentcloud/underscore


## wrench-js ##

wrench-js is distributed under the MIT license, which is reproduced above.
Expand Down
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ An API documentation generator for JavaScript.

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


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

Expand Down Expand Up @@ -92,7 +91,6 @@ can use the `--destination` (`-d`) option to specify another directory.

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


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

Expand All @@ -103,7 +101,6 @@ JSDoc 3 Ant Task: <https://github.com/jannon/jsdoc3-ant-task>
JSDoc Grunt Plugin: <https://github.com/krampstudio/grunt-jsdoc>
Project Announcements: <http://twitter.com/jsdoc3>


License
-------

Expand Down
8 changes: 0 additions & 8 deletions changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

This file describes notable changes in each version of JSDoc 3. To download a specific version of JSDoc 3, see [GitHub's tags page](https://github.com/jsdoc3/jsdoc/tags).


## 3.2.2 (November 2013)

### Bug fixes
Expand All @@ -13,7 +12,6 @@ This file describes notable changes in each version of JSDoc 3. To download a sp
+ If a function accepts a parameter named `prototype`, the parameter is no longer renamed during parsing. (#505)
+ If the list of input files includes relative paths, the paths are now resolved relative to the user's working directory. (a3d33842)


## 3.2.1 (October 2013)

### Enhancements
Expand Down Expand Up @@ -45,7 +43,6 @@ This file describes notable changes in each version of JSDoc 3. To download a sp
+ If a `@default` tag is added to a symbol whose default value is an object, the value is now displayed in the output file. (#419)
+ Output files now identify symbols as "abstract" rather than "virtual." (#432)


## 3.2.0 (May 2013)

### Major changes
Expand Down Expand Up @@ -76,7 +73,6 @@ This file describes notable changes in each version of JSDoc 3. To download a sp
+ You can now use npm to install JSDoc globally by running `npm install -g`. **Note**: JSDoc will still run under Mozilla Rhino, not Node.js. (#374)
+ The `jsVersion` configuration property has been removed. (#390)


### Bug fixes
+ JSDoc now quits if the configuration file cannot be loaded. (#407)
+ JSDoc's `--explain` (`-X`) option now runs much more quickly, and it outputs valid JSON to the console. (#298)
Expand Down Expand Up @@ -105,7 +101,6 @@ This file describes notable changes in each version of JSDoc 3. To download a sp
+ The "Classes" header is no longer repeated in the navigation bar. (#361)
+ When the only documented symbols in global scope are type definitions, you can now click the "Global" header to view their documentation. (#261)


## 3.1.1 (February 2013)

+ Resolved a crash when no input files contain JSDoc comments. (#329)
Expand All @@ -119,7 +114,6 @@ This file describes notable changes in each version of JSDoc 3. To download a sp
+ `getSignatureTypes`
+ `linkto`


## 3.1.0 (January 2013)

### Major changes
Expand Down Expand Up @@ -224,7 +218,6 @@ This file describes notable changes in each version of JSDoc 3. To download a sp
+ Members are now contained in arrays rather than objects, allowing overloaded members to be documented. (#153)
+ A clearer error message is now provided when the output destination is not specified correctly. (#174)


## 3.0.1 (June 2012)

### Enhancements
Expand All @@ -242,7 +235,6 @@ This file describes notable changes in each version of JSDoc 3. To download a sp
+ The default template now sorts classes by name correctly when the classes come from several modules. (4ce17195)
+ The Haruki template now correctly supports `@example`, `@members`, and `@returns` tags. (6580e176, 59655252, 31c8554d)


## 3.0.0 (May 2012)

Initial release.
4 changes: 2 additions & 2 deletions cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ cli.scanFiles = function() {
props.packageJson = fs.readFileSync(opt, 'utf8');
env.opts._.splice(i--, 1);
}

if ( /(\bREADME|\.md)$/i.test(opt) ) {
env.opts.readme = new Readme(opt).html;
env.opts._.splice(i--, 1);
Expand Down Expand Up @@ -504,7 +504,7 @@ cli.exit = function(exitCode, message) {
if (message && exitCode > 0) {
console.error(message);
}

process.exit(exitCode || 0);
};

Expand Down
4 changes: 2 additions & 2 deletions jsdoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ global.env = {
* @memberof env
*/
sourceFiles: [],

/**
* The JSDoc version number and revision date.
*
Expand Down Expand Up @@ -125,7 +125,7 @@ global.dump = function() {

(function() {
'use strict';

var logger = require('jsdoc/util/logger');
var path = require('jsdoc/path');
var runtime = require('jsdoc/util/runtime');
Expand Down
4 changes: 2 additions & 2 deletions lib/jsdoc/augment.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ Sorter.prototype.visit = function(key) {

if (!(key in this.visited)) {
this.visited[key] = true;

if (this.dependencies[key]) {
Object.keys(this.dependencies[key]).forEach(function(path) {
self.visit(path);
});
});
}

this.sorted.push(key);
Expand Down
Loading

0 comments on commit 48e6c39

Please sign in to comment.