codo/spec/_templates/mixins/mixin_methods.json

A CoffeeScript documentation generator.

[
  {
    "file": "spec/_templates/mixins/mixin_methods.coffee",
    "methods": [],
    "variables": []
  },
  {
    "file": "spec/_templates/mixins/mixin_methods.coffee",
    "name": "Foo",
    "documentation": {
      "comment": "",
      "summary": "",
      "methods": [
        {
          "signature": "#set(key, value)",
          "documentation": {
            "params": [
              {
                "type": "String",
                "name": "key",
                "description": "describe key param"
              },
              {
                "type": "Object",
                "name": "value",
                "description": "describe value param"
              }
            ],
            "options": {
              "value": [
                {
                  "type": "String",
                  "name": "string"
                },
                {
                  "type": "Integer",
                  "name": "number"
                },
                {
                  "type": "Object",
                  "name": "whatever"
                }
              ]
            },
            "comment": "Sets a value",
            "summary": "Sets a value"
          }
        }
      ]
    },
    "methods": [
      {
        "file": "spec/_templates/mixins/mixin_methods.coffee",
        "name": "helper",
        "bound": false,
        "parameters": []
      },
      {
        "file": "spec/_templates/mixins/mixin_methods.coffee",
        "name": "another",
        "bound": false,
        "parameters": [
          {
            "name": "a",
            "splat": false
          },
          {
            "name": "b",
            "splat": false
          }
        ]
      },
      {
        "file": "spec/_templates/mixins/mixin_methods.coffee",
        "name": "withDefault",
        "bound": false,
        "parameters": [
          {
            "name": "a",
            "splat": false,
            "default": "2"
          },
          {
            "name": "c",
            "splat": false
          },
          {
            "name": "d",
            "splat": false,
            "default": "'hi'"
          },
          {
            "name": "d",
            "splat": false
          },
          {
            "name": "e",
            "splat": false,
            "default": "{\n  a: 2\n}"
          },
          {
            "name": "f",
            "splat": false,
            "default": "new TestClassMethods()"
          }
        ]
      },
      {
        "file": "spec/_templates/mixins/mixin_methods.coffee",
        "name": "nowWithSpalt",
        "bound": false,
        "parameters": [
          {
            "name": "foo",
            "splat": false
          },
          {
            "name": "bar",
            "splat": true
          }
        ]
      }
    ],
    "variables": []
  },
  {
    "file": "spec/_templates/mixins/mixin_methods.coffee",
    "name": "helper",
    "bound": false,
    "parameters": []
  },
  {
    "file": "spec/_templates/mixins/mixin_methods.coffee",
    "name": "another",
    "bound": false,
    "parameters": [
      {
        "name": "a",
        "splat": false
      },
      {
        "name": "b",
        "splat": false
      }
    ]
  },
  {
    "file": "spec/_templates/mixins/mixin_methods.coffee",
    "name": "withDefault",
    "bound": false,
    "parameters": [
      {
        "name": "a",
        "splat": false,
        "default": "2"
      },
      {
        "name": "c",
        "splat": false
      },
      {
        "name": "d",
        "splat": false,
        "default": "'hi'"
      },
      {
        "name": "d",
        "splat": false
      },
      {
        "name": "e",
        "splat": false,
        "default": "{\n  a: 2\n}"
      },
      {
        "name": "f",
        "splat": false,
        "default": "new TestClassMethods()"
      }
    ]
  },
  {
    "file": "spec/_templates/mixins/mixin_methods.coffee",
    "name": "a",
    "constant": false,
    "value": "2"
  },
  {
    "file": "spec/_templates/mixins/mixin_methods.coffee",
    "name": "nowWithSpalt",
    "bound": false,
    "parameters": [
      {
        "name": "foo",
        "splat": false
      },
      {
        "name": "bar",
        "splat": true
      }
    ]
  }
]