Skip to content

Commit

Permalink
trailing whitespace cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
hegemonic committed Mar 4, 2014
1 parent dd27185 commit 49ad746
Show file tree
Hide file tree
Showing 40 changed files with 120 additions and 121 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Pull Requests
-------------

If you're thinking about making some changes, maybe fixing a bug, or adding a
snazzy new feature, first, thank you. Contributions are very welcome. Things
need to be manageable for the maintainers, however. So below you'll find **The
If you're thinking about making some changes, maybe fixing a bug, or adding a
snazzy new feature, first, thank you. Contributions are very welcome. Things
need to be manageable for the maintainers, however. So below you'll find **The
fastest way to get your pull request merged in.** Some things, particularly how
you set up your branches and work with git, are just suggestions, but pretty good
ones.
Expand All @@ -14,7 +14,7 @@ ones.

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.
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
Expand Down Expand Up @@ -64,6 +64,6 @@ ones.
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
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
your code if they know what its supposed to be about.
4 changes: 2 additions & 2 deletions cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
* Helper methods for running JSDoc on the command line.
*
* A few critical notes for anyone who works on this module:
*
*
* + The module should really export an instance of `cli`, and `props` should be properties of a
* `cli` instance. However, Rhino interpreted `this` as a reference to `global` within the
* prototype's methods, so we couldn't do that.
* + On Rhino, for unknown reasons, the `jsdoc/fs` and `jsdoc/path` modules can fail in some cases
* when they are required by this module. You may need to use `fs` and `path` instead.
*
*
* @private
*/
module.exports = (function() {
Expand Down
14 changes: 7 additions & 7 deletions jsdoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
global.env = {
/**
* Running start and finish times.
*
*
* @memberof env
*/
run: {
Expand All @@ -32,15 +32,15 @@ global.env = {

/**
* The parsed JSON data from the configuration file.
*
*
* @type Object
* @memberof env
*/
conf: {},

/**
* The absolute path to the base directory of the JSDoc application.
*
*
* @private
* @type string
* @memberof env
Expand All @@ -58,7 +58,7 @@ global.env = {

/**
* The command-line options, parsed into a key/value hash.
*
*
* @type Object
* @memberof env
* @example if (global.env.opts.help) { console.log('Helpful message.'); }
Expand All @@ -74,7 +74,7 @@ global.env = {

/**
* The JSDoc version number and revision date.
*
*
* @type Object
* @memberof env
*/
Expand All @@ -93,7 +93,7 @@ global.env = {

/**
* Data that must be shared across the entire application.
*
*
* @namespace
* @name app
*/
Expand All @@ -109,7 +109,7 @@ global.app = {
* Recursively print an object's properties to stdout. This method is safe to use with objects that
* contain circular references. In addition, on Mozilla Rhino, this method is safe to use with
* native Java objects.
*
*
* @global
* @name dump
* @private
Expand Down
10 changes: 5 additions & 5 deletions lib/jsdoc/doclet.js
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Doclet.prototype.postProcess = function() {

/**
* Add a tag to the doclet.
*
*
* @param {string} title - The title of the tag being added.
* @param {string} [text] - The text of the tag being added.
*/
Expand Down Expand Up @@ -231,7 +231,7 @@ Doclet.prototype.setMemberof = function(sid) {

/**
* Set the doclet's `longname` property.
*
*
* @param {string} name - The longname for the doclet.
*/
Doclet.prototype.setLongname = function(name) {
Expand Down Expand Up @@ -289,9 +289,9 @@ Doclet.prototype.setScope = function(scope) {
this.scope = scope;
};

/**
/**
* Add a symbol to this doclet's `borrowed` array.
*
*
* @param {string} source - The longname of the symbol that is the source.
* @param {string} target - The name the symbol is being assigned to.
*/
Expand Down Expand Up @@ -336,7 +336,7 @@ Doclet.prototype.augment = function(base) {

/**
* Set the `meta` property of this doclet.
*
*
* @param {object} meta
*/
Doclet.prototype.setMeta = function(meta) {
Expand Down
2 changes: 1 addition & 1 deletion lib/jsdoc/src/visitor.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Visitor.prototype.visit = function(node, filename) {
/**
* Verify that a block comment exists and that its leading delimiter does not contain three or more
* asterisks.
*
*
* @private
* @memberof module:jsdoc/src/parser.Parser
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/jsdoc/src/walker.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Traversal utilities for ASTs that are compatible with the Mozilla Parser API. Adapted from
* [Acorn](http://marijnhaverbeke.nl/acorn/).
*
*
* @module jsdoc/src/walker
* @license MIT
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/jsdoc/tag/dictionary/definitions.js
Original file line number Diff line number Diff line change
Expand Up @@ -603,7 +603,7 @@ exports.defineTags = function(dictionary) {

var MODULE_PREFIX = require('jsdoc/name').MODULE_PREFIX;

// inline link tags are passed through as-is so that `@requires {@link foo}` works
// inline link tags are passed through as-is so that `@requires {@link foo}` works
if ( require('jsdoc/tag/inline').isInlineTag(tag.value, 'link\\S*') ) {
requiresName = tag.value;
}
Expand Down
2 changes: 1 addition & 1 deletion lib/jsdoc/tag/inline.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @module jsdoc/tag/inline
*
*
* @author Jeff Williams <[email protected]>
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
*/
Expand Down
4 changes: 2 additions & 2 deletions lib/jsdoc/tag/type.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @module jsdoc/tag/type
*
*
* @author Michael Mathews <[email protected]>
* @author Jeff Williams <[email protected]>
* @license Apache License 2.0 - See file 'LICENSE.md' in this project.
Expand Down Expand Up @@ -146,7 +146,7 @@ function getTagInfo(tagValue, canHaveName, canHaveType) {
/**
* Extract JSDoc-style type information from the name specified in the tag info, including the
* member name; whether the member is optional; and the default value of the member.
*
*
* @private
* @param {module:jsdoc/tag/type.TagInfo} tagInfo - Information contained in the tag.
* @return {module:jsdoc/tag/type.TagInfo} Updated information from the tag.
Expand Down
2 changes: 1 addition & 1 deletion lib/jsdoc/util/logger.js
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ logger.warn = wrapLogFunction('warn', console.warn);

/**
* Set the log level.
*
*
* @param {module:jsdoc/util/logger.LEVELS} level - The log level to use.
*/
logger.setLevel = function setLevel(level) {
Expand Down
2 changes: 1 addition & 1 deletion lib/jsdoc/util/markdown.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ function escapeUrls(source) {

/**
* Unescape HTTP/HTTPS URLs after Markdown parsing is complete.
*
*
* @param {string} source - The source text to unescape.
* @return {string} The source text with escape characters removed from HTTP/HTTPS URLs.
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/jsdoc/util/runtime.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*global env: true */
/**
* Helper functions to enable JSDoc to run on multiple JavaScript runtimes.
*
*
* @module jsdoc/util/runtime
* @private
*/
Expand Down
4 changes: 2 additions & 2 deletions plugins/overloadHelper.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
* overloaded functions and methods. In JSDoc, this string is known as a _variation_. (The longnames
* of overloaded constructor functions are _not_ updated, so that JSDoc can identify the class'
* members correctly.)
*
*
* Using this plugin allows you to link to overloaded functions without manually adding `@variation`
* tags to your documentation.
*
*
* For example, suppose your code includes a function named `foo` that you can call in the
* following ways:
*
Expand Down
2 changes: 1 addition & 1 deletion rhino/MPL_2.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Mozilla Public License Version 2.0
means any form of the work other than Source Code Form.

1.7. "Larger Work"
means a work that combines Covered Software with other material, in
means a work that combines Covered Software with other material, in
a separate file or files, that is not Covered Software.

1.8. "License"
Expand Down
2 changes: 1 addition & 1 deletion templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For example:

/**
* Generate documentation output.
*
*
* @param {TAFFY} data - A TaffyDB collection representing
* all the symbols documented in your code.
* @param {object} opts - An object with options information.
Expand Down
2 changes: 1 addition & 1 deletion templates/default/publish.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ function generateSourceFiles(sourceFiles, encoding) {
* exports only that class or function), then attach the classes or functions to the `module`
* property of the appropriate module doclets. The name of each class or function is also updated
* for display purposes. This function mutates the original arrays.
*
*
* @private
* @param {Array.<module:jsdoc/doclet.Doclet>} doclets - The array of classes and functions to
* check.
Expand Down
24 changes: 12 additions & 12 deletions templates/default/tmpl/container.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<?js if (doc.classdesc) { ?>
<div class="class-description"><?js= doc.classdesc ?></div>
<?js } ?>
</header>
</header>

<article>
<div class="container-overview">
Expand Down Expand Up @@ -71,8 +71,8 @@
<?js } ?>

<?js
var classes = self.find({kind: 'class', memberof: doc.longname});
if (doc.kind !== 'globalobj' && classes && classes.length) {
var classes = self.find({kind: 'class', memberof: doc.longname});
if (doc.kind !== 'globalobj' && classes && classes.length) {
?>
<h3 class="subsection-title">Classes</h3>

Expand All @@ -83,8 +83,8 @@
<?js } ?>

<?js
var namespaces = self.find({kind: 'namespace', memberof: doc.longname});
if (doc.kind !== 'globalobj' && namespaces && namespaces.length) {
var namespaces = self.find({kind: 'namespace', memberof: doc.longname});
if (doc.kind !== 'globalobj' && namespaces && namespaces.length) {
?>
<h3 class="subsection-title">Namespaces</h3>

Expand All @@ -96,7 +96,7 @@

<?js
var members = self.find({kind: 'member', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
if (members && members.length && members.forEach) {
if (members && members.length && members.forEach) {
?>
<h3 class="subsection-title">Members</h3>

Expand All @@ -107,7 +107,7 @@

<?js
var methods = self.find({kind: 'function', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
if (methods && methods.length && methods.forEach) {
if (methods && methods.length && methods.forEach) {
?>
<h3 class="subsection-title">Methods</h3>

Expand All @@ -117,8 +117,8 @@
<?js } ?>

<?js
var typedefs = self.find({kind: 'typedef', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
if (typedefs && typedefs.length && typedefs.forEach) {
var typedefs = self.find({kind: 'typedef', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
if (typedefs && typedefs.length && typedefs.forEach) {
?>
<h3 class="subsection-title">Type Definitions</h3>

Expand All @@ -137,8 +137,8 @@
<?js } ?>

<?js
var events = self.find({kind: 'event', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
if (events && events.length && events.forEach) {
var events = self.find({kind: 'event', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
if (events && events.length && events.forEach) {
?>
<h3 class="subsection-title">Events</h3>

Expand All @@ -148,7 +148,7 @@
<?js } ?>
</article>

</section>
</section>
<?js } ?>

<?js }); ?>
2 changes: 1 addition & 1 deletion templates/default/tmpl/details.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ if (data.defaultvalue && data.defaultvaluetype === 'object') {
<dl class="details">
<?js
var properties = data.properties;
if (properties && properties.length && properties.forEach) {
if (properties && properties.length && properties.forEach) {
?>

<h5 class="subsection-title">Properties:</h5>
Expand Down
4 changes: 2 additions & 2 deletions templates/default/tmpl/tutorial.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@
<?js } ?>

<h2><?js= header ?></h2>
</header>
</header>

<article>
<?js= content ?>
</article>

</section>
</section>
4 changes: 2 additions & 2 deletions test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you can't get the short-form commands to work, try invoking Java directly:
Writing Tests
-------------

Adding tests is pretty easy, too. You can write tests for JSDoc itself (to
Adding tests is pretty easy, too. You can write tests for JSDoc itself (to
make sure tags and the parser, etc. are working properly), tests for plugins, and/or
tests for templates.

Expand All @@ -42,4 +42,4 @@ tests that were installed with the Jakefile install task will be run automatical

### Tests for templates

TODO
TODO
Loading

0 comments on commit 49ad746

Please sign in to comment.