codo/spec/_templates/methods/method_documentation.json

A CoffeeScript documentation generator.

[
  {
    "file": "spec/_templates/methods/method_documentation.coffee",
    "methods": [],
    "variables": []
  },
  {
    "file": "spec/_templates/methods/method_documentation.coffee",
    "name": "App.TestMethodDocumentation",
    "parent": "App.Doc",
    "methods": [
      {
        "file": "spec/_templates/methods/method_documentation.coffee",
        "name": "fetchLimit",
        "bound": false,
        "documentation": {
          "comment": "Should be overloaded to change fetch limit.",
          "summary": "Should be overloaded to change fetch limit.",
          "returns": {
            "type": "?",
            "description": "Number of items per fetch"
          }
        },
        "kind": "dynamic",
        "parameters": []
      },
      {
        "file": "spec/_templates/methods/method_documentation.coffee",
        "name": "do",
        "bound": false,
        "documentation": {
          "comment": "Do it!",
          "summary": "Do it!",
          "see": [
            {
              "reference": "#undo",
              "label": "for more information"
            }
          ],
          "private": true,
          "params": [
            {
              "type": "String",
              "name": "it",
              "description": "The thing to do"
            },
            {
              "type": "Boolean",
              "name": "again",
              "description": "Do it again"
            },
            {
              "type": "Object",
              "name": "options",
              "description": "The do options"
            }
          ],
          "options": {
            "options": [
              {
                "type": "String",
                "name": "speed",
                "description": "The speed"
              },
              {
                "type": "Number",
                "name": "repeat",
                "description": "How wany time to repeat"
              },
              {
                "type": "Array<Tasks>",
                "name": "tasks",
                "description": "The tasks to do"
              }
            ]
          },
          "returns": {
            "type": "Boolean",
            "description": "When successful executed"
          },
          "throws": [
            {
              "type": "TypeError",
              "description": "when it can't be done"
            }
          ]
        },
        "kind": "dynamic",
        "parameters": [
          {
            "name": "it",
            "splat": false
          },
          {
            "name": "again",
            "splat": false
          },
          {
            "name": "options",
            "splat": false
          }
        ]
      },
      {
        "file": "spec/_templates/methods/method_documentation.coffee",
        "name": "doWithoutSpace",
        "bound": false,
        "documentation": {
          "comment": "Do it!",
          "summary": "Do it!",
          "see": [
            {
              "reference": "#undo",
              "label": "for more information"
            }
          ],
          "private": true,
          "params": [
            {
              "type": "String",
              "name": "it",
              "description": "The thing to do"
            },
            {
              "type": "Boolean",
              "name": "again",
              "description": "Do it again"
            },
            {
              "type": "Object",
              "name": "options",
              "description": "The do options"
            }
          ],
          "options": {
            "options": [
              {
                "type": "String",
                "name": "speed",
                "description": "The speed"
              },
              {
                "type": "Number",
                "name": "repeat",
                "description": "How wany time to repeat"
              },
              {
                "type": "Array<Tasks>",
                "name": "tasks",
                "description": "The tasks to do"
              }
            ]
          },
          "returns": {
            "type": "Boolean",
            "description": "When successful executed"
          }
        },
        "kind": "dynamic",
        "parameters": [
          {
            "name": "it",
            "splat": false
          },
          {
            "name": "again",
            "splat": false
          },
          {
            "name": "options",
            "splat": false
          }
        ]
      },
      {
        "file": "spec/_templates/methods/method_documentation.coffee",
        "name": "lets_do_it",
        "bound": false,
        "documentation": {
          "comment": "Do it!",
          "summary": "Do it!",
          "see": [
            {
              "reference": "{#undo}",
              "label": "for more information"
            }
          ],
          "private": true,
          "params": [
            {
              "type": "String",
              "name": "it",
              "description": "The thing to do"
            },
            {
              "type": "Object",
              "name": "options",
              "description": "The do options"
            }
          ],
          "options": {
            "options": [
              {
                "type": "String",
                "name": "speed",
                "description": "The speed"
              },
              {
                "type": "Number",
                "name": "repeat",
                "description": "How wany time to repeat"
              },
              {
                "type": "Array<Tasks>",
                "name": "tasks",
                "description": "The tasks to do"
              }
            ]
          },
          "returns": {
            "type": "Boolean",
            "description": "When successful executed"
          }
        },
        "selfish": true,
        "kind": "static",
        "parameters": [
          {
            "name": "it",
            "splat": false
          },
          {
            "name": "options",
            "splat": false
          }
        ]
      }
    ],
    "variables": [],
    "properties": [],
    "includes": [],
    "extends": [],
    "concerns": []
  },
  {
    "file": "spec/_templates/methods/method_documentation.coffee",
    "name": "fetchLimit",
    "bound": false,
    "documentation": {
      "comment": "Should be overloaded to change fetch limit.",
      "summary": "Should be overloaded to change fetch limit.",
      "returns": {
        "type": "?",
        "description": "Number of items per fetch"
      }
    },
    "kind": "dynamic",
    "parameters": []
  },
  {
    "file": "spec/_templates/methods/method_documentation.coffee",
    "name": "do",
    "bound": false,
    "documentation": {
      "comment": "Do it!",
      "summary": "Do it!",
      "see": [
        {
          "reference": "#undo",
          "label": "for more information"
        }
      ],
      "private": true,
      "params": [
        {
          "type": "String",
          "name": "it",
          "description": "The thing to do"
        },
        {
          "type": "Boolean",
          "name": "again",
          "description": "Do it again"
        },
        {
          "type": "Object",
          "name": "options",
          "description": "The do options"
        }
      ],
      "options": {
        "options": [
          {
            "type": "String",
            "name": "speed",
            "description": "The speed"
          },
          {
            "type": "Number",
            "name": "repeat",
            "description": "How wany time to repeat"
          },
          {
            "type": "Array<Tasks>",
            "name": "tasks",
            "description": "The tasks to do"
          }
        ]
      },
      "returns": {
        "type": "Boolean",
        "description": "When successful executed"
      },
      "throws": [
        {
          "type": "TypeError",
          "description": "when it can't be done"
        }
      ]
    },
    "kind": "dynamic",
    "parameters": [
      {
        "name": "it",
        "splat": false
      },
      {
        "name": "again",
        "splat": false
      },
      {
        "name": "options",
        "splat": false
      }
    ]
  },
  {
    "file": "spec/_templates/methods/method_documentation.coffee",
    "name": "doWithoutSpace",
    "bound": false,
    "documentation": {
      "comment": "Do it!",
      "summary": "Do it!",
      "see": [
        {
          "reference": "#undo",
          "label": "for more information"
        }
      ],
      "private": true,
      "params": [
        {
          "type": "String",
          "name": "it",
          "description": "The thing to do"
        },
        {
          "type": "Boolean",
          "name": "again",
          "description": "Do it again"
        },
        {
          "type": "Object",
          "name": "options",
          "description": "The do options"
        }
      ],
      "options": {
        "options": [
          {
            "type": "String",
            "name": "speed",
            "description": "The speed"
          },
          {
            "type": "Number",
            "name": "repeat",
            "description": "How wany time to repeat"
          },
          {
            "type": "Array<Tasks>",
            "name": "tasks",
            "description": "The tasks to do"
          }
        ]
      },
      "returns": {
        "type": "Boolean",
        "description": "When successful executed"
      }
    },
    "kind": "dynamic",
    "parameters": [
      {
        "name": "it",
        "splat": false
      },
      {
        "name": "again",
        "splat": false
      },
      {
        "name": "options",
        "splat": false
      }
    ]
  },
  {
    "file": "spec/_templates/methods/method_documentation.coffee",
    "name": "lets_do_it",
    "bound": false,
    "documentation": {
      "comment": "Do it!",
      "summary": "Do it!",
      "see": [
        {
          "reference": "{#undo}",
          "label": "for more information"
        }
      ],
      "private": true,
      "params": [
        {
          "type": "String",
          "name": "it",
          "description": "The thing to do"
        },
        {
          "type": "Object",
          "name": "options",
          "description": "The do options"
        }
      ],
      "options": {
        "options": [
          {
            "type": "String",
            "name": "speed",
            "description": "The speed"
          },
          {
            "type": "Number",
            "name": "repeat",
            "description": "How wany time to repeat"
          },
          {
            "type": "Array<Tasks>",
            "name": "tasks",
            "description": "The tasks to do"
          }
        ]
      },
      "returns": {
        "type": "Boolean",
        "description": "When successful executed"
      }
    },
    "selfish": true,
    "kind": "static",
    "parameters": [
      {
        "name": "it",
        "splat": false
      },
      {
        "name": "options",
        "splat": false
      }
    ]
  }
]