From a6811e3ca3606381a7e831a57f77754ab2af3c10 Mon Sep 17 00:00:00 2001 From: Alberto La Rocca Date: Mon, 23 Dec 2013 10:48:23 +0100 Subject: [PATCH] Docs --- Gruntfile.js | 14 +++++++++++++- src/lock.js | 8 ++++---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/Gruntfile.js b/Gruntfile.js index 69e11b8..912204e 100644 --- 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 index 8dccbd2..58308dc 100644 --- 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