Docs

71104 · Dec 23, 2013 · a6811e3 · a6811e3
1 parent 1a2709e
commit a6811e3
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 5 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -70,7 +70,19 @@ module.exports = function (grunt) {
 			}
 		},
 
-		yuidoc: {}
+		yuidoc: {
+			compile: {
+				name: 'ReadWriteLock',
+				description: '<%= pkg.description %>',
+				version: '<%= pkg.version %>',
+				url: '<%= pkg.homepage %>',
+				options: {
+					paths: 'src/',
+					outdir: 'doc/',
+					linkNatives: 'true'
+				}
+			}
+		}
 	});
 
 	grunt.loadNpmTasks('grunt-contrib-clean');

diff --git a/src/lock.js b/src/lock.js
@@ -2,12 +2,12 @@
  * Asynchronous read/write lock implementation for Node.
  *
  * The rules:
- *	- there may be zero or more readers at the same time,
- *	- there may be only one writer at a time,
- *	- if there is a writer there may be no readers.
+ * - there may be zero or more readers at the same time,
+ * - there may be only one writer at a time,
+ * - if there is a writer there may be no readers.
  *
  * ReadWriteLock also supports multiple independent locks identified by custom
- * user-defined strings called `keys'.
+ * user-defined strings called "keys".
  *
  * @class ReadWriteLock
  * @constructor