Fix removeFolder() JSDoc.

This commit is contained in:
Don McCurdy 2017-12-23 12:04:38 -05:00
parent d783b759cf
commit af282f908c
2 changed files with 8 additions and 4 deletions

10
API.md
View File

@ -45,7 +45,7 @@ manipulate variables and fire functions on the fly.
* [.remove(controller)](#GUI+remove) * [.remove(controller)](#GUI+remove)
* [.destroy()](#GUI+destroy) * [.destroy()](#GUI+destroy)
* [.addFolder(name)](#GUI+addFolder) ⇒ <code>dat.gui.GUI</code> * [.addFolder(name)](#GUI+addFolder) ⇒ <code>dat.gui.GUI</code>
* [.removeFolder()](#GUI+removeFolder) * [.removeFolder(folder)](#GUI+removeFolder)
* [.open()](#GUI+open) * [.open()](#GUI+open)
* [.close()](#GUI+close) * [.close()](#GUI+close)
* [.getRoot()](#GUI+getRoot) ⇒ <code>dat.gui.GUI</code> * [.getRoot()](#GUI+getRoot) ⇒ <code>dat.gui.GUI</code>
@ -230,11 +230,15 @@ name
<a name="GUI+removeFolder"></a> <a name="GUI+removeFolder"></a>
### gui.removeFolder() ### gui.removeFolder(folder)
Removes a subfolder GUI instance. Removes a subfolder GUI instance.
{dat.gui.GUI} folder The folder to remove.
**Kind**: instance method of [<code>GUI</code>](#GUI) **Kind**: instance method of [<code>GUI</code>](#GUI)
| Param | Type | Description |
| --- | --- | --- |
| folder | <code>dat.gui.GUI</code> | The folder to remove. |
<a name="GUI+open"></a> <a name="GUI+open"></a>
### gui.open() ### gui.open()

View File

@ -630,7 +630,7 @@ common.extend(
/** /**
* Removes a subfolder GUI instance. * Removes a subfolder GUI instance.
* {dat.gui.GUI} folder The folder to remove. * @param {dat.gui.GUI} folder The folder to remove.
* @instance * @instance
*/ */
removeFolder: function(folder) { removeFolder: function(folder) {