From b4b09930bd7c5e8bb6e9f5eafafaa92869aa9ba1 Mon Sep 17 00:00:00 2001 From: Mike Gerwitz Date: Sat, 13 Aug 2011 22:40:06 -0400 Subject: [PATCH] Added property object comment to VisibilityObjectFactory (#25) --- lib/VisibilityObjectFactory.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/VisibilityObjectFactory.js b/lib/VisibilityObjectFactory.js index da017e3..b07a267 100644 --- a/lib/VisibilityObjectFactory.js +++ b/lib/VisibilityObjectFactory.js @@ -53,6 +53,10 @@ module.exports = exports = function VisibilityObjectFactory() * object will include the destination object in the prototype, so that the * access should be transparent. This object is returned. * + * Properties are expected in the following format. Note that keywords are + * ignored: + * { public: { prop: [ value, { keyword: true } ] } } + * * @param {Object} dest destination object * @param {Object} properties properties to copy * @param {Object=} methods methods to copy