clean up, start docs

Author: jonschlinkert

.travis.yml

@@ -2,14 +2,15 @@ sudo: false
 os:
   - linux
   - osx
+  - windows
 language: node_js
 node_js:
   - node
+  - '11'
+  - '10'
   - '9'
   - '8'
   - '7'
   - '6'
   - '5'
   - '4'
-  - '0.12'
-  - '0.10'

.verb.md

@@ -11,22 +11,19 @@ Parses a comment like this:
 
 ```js
 /**
- * Register a handler function to be called on a node of the given `type`.
- * Override a built-in handler `type`, or register a new type.
+ * Create an instance of `CustomClass` with the given `options`.
  *
- * ```js
- * comments.set('param', function(node) {
- *   // do stuff to node
- * });
- * ```
- * @param {String} `type` The `node.type` to call the handler on. You can override built-in middleware by registering a handler of the same name, or register a handler for rendering a new type.
- * @param {Function} `fn` The handler function
- * @return {Object} Returns the instance for chaining.
+ * @param {String} options
  * @api public
  */
 
-set(type, fn) {
-  // do stuff
+class CustomClass {
+  constructor(options) {
+    this.options = options;
+  }
+  set(type, fn) {
+    // do stuff
+  }
 }
 ```
 
@@ -36,90 +33,40 @@ Into an array of comment objects, like this:
 [
   {
     type: 'BlockComment',
-    val:
-      '\nRegister a handler function to be called on a node of the given `type`.\nOverride a built-in handler `type`, or register a new type.\n\n```js\ncomments.set("param", function(node) {\n  // do stuff to node\n});\n```\n@param {String} `type` The `node.type` to call the handler on. You can override built-in middleware by registering a handler of the same name, or register a handler for rendering a new type.\n@param {Function} `fn` The handler function\n@return {Object} Returns the instance for chaining.\n@api public',
-    range: [0, 549],
-    loc: {
-      start: {
-        line: 1,
-        column: 0
-      },
-      end: {
-        line: 14,
-        column: 3
-      }
-    },
-    codeStart: 551,
+    value: '\nCreate an instance of `CustomClass` with the given `options`.\n\n@param {String} options\n@api public',
+    range: [0, 117],
+    loc: { start: { line: 1, column: 0 }, end: { line: 6, column: 3 } },
+    codeStart: 119,
     raw:
-      '*\n * Register a handler function to be called on a node of the given `type`.\n * Override a built-in handler `type`, or register a new type.\n *\n * ```js\n * comments.set("param", function(node) {\n *   // do stuff to node\n * });\n * ```\n * @param {String} `type` The `node.type` to call the handler on. You can override built-in middleware by registering a handler of the same name, or register a handler for rendering a new type.\n * @param {Function} `fn` The handler function\n * @return {Object} Returns the instance for chaining.\n * @api public\n ',
+      '*\n * Create an instance of `CustomClass` with the given `options`.\n *\n * @param {String} options\n * @api public\n ',
     code: {
       context: {
-        type: 'method',
-        ctor: undefined,
-        name: 'undefinedset',
-        params: ['type', 'fn'],
-        string: 'undefinedset()'
+        type: 'class',
+        ctor: 'CustomClass',
+        name: 'CustomClass',
+        extends: undefined,
+        string: 'new CustomClass()'
       },
-      val: 'set(type, fn) {',
-      range: [551, 566],
-      loc: {
-        start: {
-          line: 16,
-          column: 0
-        },
-        end: {
-          line: 16,
-          column: 15
-        }
-      }
+      value: 'class CustomClass {',
+      range: [119, 138],
+      loc: { start: { line: 8, column: 0 }, end: { line: 8, column: 19 } }
     },
-    description:
-      'Register a handler function to be called on a node of the given `type`.\nOverride a built-in handler `type`, or register a new type.',
+    description: 'Create an instance of `CustomClass` with the given `options`.',
     footer: '',
-    examples: [
-      {
-        type: 'gfm',
-        raw: '```js\ncomments.set("param", function(node) {\n  // do stuff to node\n});\n```',
-        description: '',
-        language: 'js',
-        val: '\ncomments.set("param", function(node) {\n  // do stuff to node\n});\n'
-      }
-    ],
+    examples: [],
     tags: [
       {
         title: 'param',
-        name: 'type',
-        description:
-          'The `node.type` to call the handler on. You can override built-in middleware by registering a handler of the same name, or register a handler for rendering a new type.',
-        type: {
-          type: 'NameExpression',
-          name: 'String'
-        }
-      },
-      {
-        title: 'param',
-        name: 'fn',
-        description: 'The handler function',
-        type: {
-          type: 'NameExpression',
-          name: 'Function'
-        }
-      },
-      {
-        title: 'return',
-        name: '',
-        description: 'Returns the instance for chaining.',
-        type: {
-          type: 'NameExpression',
-          name: 'Object'
-        }
+        name: 'options',
+        description: '',
+        type: { type: 'NameExpression', name: 'String' }
       },
-      {
-        title: 'api',
-        name: 'public',
-        description: ''
-      }
-    ]
+      { title: 'api', name: 'public', description: '' }
+    ],
+    inlineTags: []
   }
 ]
 ```
+
+## API
+{%= apidocs("index.js") %}

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2018, Jon Schlinkert.
+Copyright (c) 2014-present, Jon Schlinkert.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.