From b8aa91fa43391c11caf86e124bab8774167c242f Mon Sep 17 00:00:00 2001 From: Mike Bostock Date: Mon, 30 Aug 2010 21:16:29 -0700 Subject: [PATCH] Clarify add/remove documentation. These controls now support removal. --- www/docs/arrow.html | 18 ++++++++++-------- www/docs/dblclick.html | 18 ++++++++++-------- www/docs/drag.html | 18 ++++++++++-------- www/docs/hash.html | 18 ++++++++++-------- www/docs/wheel.html | 20 +++++++++++--------- 5 files changed, 51 insertions(+), 41 deletions(-) diff --git a/www/docs/arrow.html b/www/docs/arrow.html index 66026ee..9f6a83c 100644 --- a/www/docs/arrow.html +++ b/www/docs/arrow.html @@ -95,15 +95,17 @@

arrow

arrow.map([x])
-

Adds this control to the specified map x, or returns the - current map. This method is typically not called directly, but is - needed to support the map’s add - method.

+

Adds this control to the specified map x, removes this + control from its current map, or returns the current map. This + method is typically not called directly, but is needed to support + the map’s add method and remove methods.

-

If the argument x is specified, this control is added to - the given map and returns this. If no arguments are - specified, this method returns the current map, which defaults to - null. This method does not currently support removal.

+

If the argument x is specified, this method returns + this. If x is null, this control is removed from its + current map; otherwise, this control is added to the specified map. + If no arguments are specified, this method returns the current map, + which may be null. Whew!

diff --git a/www/docs/dblclick.html b/www/docs/dblclick.html index 9be2dea..c594d12 100644 --- a/www/docs/dblclick.html +++ b/www/docs/dblclick.html @@ -90,15 +90,17 @@

dblclick

dblclick.map([x])
-

Adds this control to the specified map x, or returns the - current map. This method is typically not called directly, but is - needed to support the map’s add - method.

+

Adds this control to the specified map x, removes this + control from its current map, or returns the current map. This + method is typically not called directly, but is needed to support + the map’s add method and remove methods.

-

If the argument x is specified, this control is added to - the given map and returns this. If no arguments are - specified, this method returns the current map, which defaults to - null. This method does not currently support removal.

+

If the argument x is specified, this method returns + this. If x is null, this control is removed from its + current map; otherwise, this control is added to the specified map. + If no arguments are specified, this method returns the current map, + which may be null. Whew!

diff --git a/www/docs/drag.html b/www/docs/drag.html index 9fa1e9b..054037e 100644 --- a/www/docs/drag.html +++ b/www/docs/drag.html @@ -89,15 +89,17 @@

drag

drag.map([x])
-

Adds this control to the specified map x, or returns the - current map. This method is typically not called directly, but is - needed to support the map’s add - method.

+

Adds this control to the specified map x, removes this + control from its current map, or returns the current map. This + method is typically not called directly, but is needed to support + the map’s add method and remove methods.

-

If the argument x is specified, this control is added to - the given map and returns this. If no arguments are - specified, this method returns the current map, which defaults to - null. This method does not currently support removal.

+

If the argument x is specified, this method returns + this. If x is null, this control is removed from its + current map; otherwise, this control is added to the specified map. + If no arguments are specified, this method returns the current map, + which may be null. Whew!

diff --git a/www/docs/hash.html b/www/docs/hash.html index 8128b52..52dfa16 100644 --- a/www/docs/hash.html +++ b/www/docs/hash.html @@ -96,15 +96,17 @@

hash

hash.map([x])
-

Adds this control to the specified map x, or returns the - current map. This method is typically not called directly, but is - needed to support the map’s add - method.

+

Adds this control to the specified map x, removes this + control from its current map, or returns the current map. This + method is typically not called directly, but is needed to support + the map’s add method and remove methods.

-

If the argument x is specified, this control is added to - the given map and returns this. If no arguments are - specified, this method returns the current map, which defaults to - null. This method does not currently support removal.

+

If the argument x is specified, this method returns + this. If x is null, this control is removed from its + current map; otherwise, this control is added to the specified map. + If no arguments are specified, this method returns the current map, + which may be null. Whew!

diff --git a/www/docs/wheel.html b/www/docs/wheel.html index 9d8a981..702a6dc 100644 --- a/www/docs/wheel.html +++ b/www/docs/wheel.html @@ -95,15 +95,17 @@

wheel

wheel.map([x])
-

Adds this control to the specified map x, or returns the - current map. This method is typically not called directly, but is - needed to support the map’s add - method.

- -

If the argument x is specified, this control is added to - the given map and returns this. If no arguments are - specified, this method returns the current map, which defaults to - null. This method does not currently support removal.

+

Adds this control to the specified map x, removes this + control from its current map, or returns the current map. This + method is typically not called directly, but is needed to support + the map’s add method and remove methods.

+ +

If the argument x is specified, this method returns + this. If x is null, this control is removed from its + current map; otherwise, this control is added to the specified map. + If no arguments are specified, this method returns the current map, + which may be null. Whew!