.clear() docs

jsdoc2md · Oct 18, 2016 · 5a2d9fb · 5a2d9fb
1 parent 840fc77
commit 5a2d9fb
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -105,7 +105,7 @@ Returns raw data direct from the underlying [jsdoc3](https://github.com/jsdoc3/j
 <a name="module_jsdoc-to-markdown--JsdocToMarkdown+clear"></a>
 
 ### jsdoc2md.clear() ⇒ <code>Promise</code>
-Clear the cache. By default, the cache is stored in the [system tmpdir](https://nodejs.org/dist/latest-v6.x/docs/api/os.html#os_os_tmpdir). MacOS clears out this directory every few days (meaning your jsdoc2md cache will be cleaned automatically).
+By default, the output of each invocation of the main generation methods (`render`, `getTemplateData` etc) is stored in the cache (your system's [temporary directory](https://nodejs.org/dist/latest-v6.x/docs/api/os.html#os_os_tmpdir)). Future jsdoc2md invocations with the same input options and source code will return the output immediately from cache, making the tool much faster/cheaper. If the input options or source code changes, fresh output will be generated. This method clears the cache, which you should never need to do unless the cache is failing for some reason. On Mac OSX, the system tmpdir clears itself every few days meaning your jsdoc2md cache will also be routinely cleared.
 
 **Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>  
 **Category**: async  

diff --git a/src/lib/jsdoc-to-markdown.js b/src/lib/jsdoc-to-markdown.js
@@ -135,7 +135,7 @@ class JsdocToMarkdown {
   }
 
   /**
-   * Clear the cache. By default, the cache is stored in the [system tmpdir](https://nodejs.org/dist/latest-v6.x/docs/api/os.html#os_os_tmpdir). MacOS clears out this directory every few days (meaning your jsdoc2md cache will be cleaned automatically).
+   * By default, the output of each invocation of the main generation methods (`render`, `getTemplateData` etc) is stored in the cache (your system's [temporary directory](https://nodejs.org/dist/latest-v6.x/docs/api/os.html#os_os_tmpdir)). Future jsdoc2md invocations with the same input options and source code will return the output immediately from cache, making the tool much faster/cheaper. If the input options or source code changes, fresh output will be generated. This method clears the cache, which you should never need to do unless the cache is failing for some reason. On Mac OSX, the system tmpdir clears itself every few days meaning your jsdoc2md cache will also be routinely cleared.
    * @returns {Promise}
    * @category async
    */