UNPKG

codo

Version:

A CoffeeScript documentation generator.

439 lines 10.6 kB
[ { "file": "spec/_templates/mixins/concern.coffee", "methods": [], "variables": [] }, { "file": "spec/_templates/mixins/concern.coffee", "name": "Example.Mixins.Concern", "concern": true, "documentation": { "comment": "This is my concern", "summary": "This is my concern" }, "methods": [], "classMethods": [ { "file": "spec/_templates/mixins/concern.coffee", "name": "a", "bound": false, "documentation": { "comment": "", "summary": "", "params": [ { "type": "String", "name": "a", "description": "This is the a parameter" }, { "type": "String", "name": "b", "description": "This is the a parameter" }, { "type": "String", "name": "c", "description": "This is the a parameter" } ] }, "parameters": [ { "name": "a", "splat": false }, { "name": "b", "splat": false }, { "name": "c", "splat": false } ] }, { "file": "spec/_templates/mixins/concern.coffee", "name": "z", "bound": false, "documentation": { "comment": "", "summary": "", "params": [ { "type": "String", "name": "x", "description": "This is the x parameter" }, { "type": "String", "name": "y", "description": "This is the y parameter" }, { "type": "String", "name": "z", "description": "This is the z parameter" } ] }, "parameters": [ { "name": "x", "splat": false }, { "name": "y", "splat": false }, { "name": "z", "splat": false } ] } ], "instanceMethods": [ { "file": "spec/_templates/mixins/concern.coffee", "name": "hi", "bound": false, "documentation": { "comment": "Say hi", "summary": "Say hi", "params": [ { "type": "String", "name": "to", "description": "the name" } ] }, "parameters": [ { "name": "to", "splat": false } ] }, { "file": "spec/_templates/mixins/concern.coffee", "name": "goodbye", "bound": false, "documentation": { "comment": "Say goodbye", "summary": "Say goodbye", "params": [ { "type": "String", "name": "to", "description": "the name" } ] }, "parameters": [ { "name": "to", "splat": false } ] } ], "variables": [] }, { "file": "spec/_templates/mixins/concern.coffee", "name": "ClassMethods", "constant": false, "value": "{\n\n /*\n @param [String] a This is the a parameter\n @param [String] b This is the a parameter\n @param [String] c This is the a parameter\n */\n a: function(a, b, c) {},\n\n /*\n @param [String] x This is the x parameter\n @param [String] y This is the y parameter\n @param [String] z This is the z parameter\n */\n z: function(x, y, z) {}\n}" }, { "file": "spec/_templates/mixins/concern.coffee", "name": "a", "bound": false, "documentation": { "comment": "", "summary": "", "params": [ { "type": "String", "name": "a", "description": "This is the a parameter" }, { "type": "String", "name": "b", "description": "This is the a parameter" }, { "type": "String", "name": "c", "description": "This is the a parameter" } ] }, "parameters": [ { "name": "a", "splat": false }, { "name": "b", "splat": false }, { "name": "c", "splat": false } ] }, { "file": "spec/_templates/mixins/concern.coffee", "name": "z", "bound": false, "documentation": { "comment": "", "summary": "", "params": [ { "type": "String", "name": "x", "description": "This is the x parameter" }, { "type": "String", "name": "y", "description": "This is the y parameter" }, { "type": "String", "name": "z", "description": "This is the z parameter" } ] }, "parameters": [ { "name": "x", "splat": false }, { "name": "y", "splat": false }, { "name": "z", "splat": false } ] }, { "file": "spec/_templates/mixins/concern.coffee", "name": "InstanceMethods", "constant": false, "value": "{\n\n /*\n Say hi\n @param [String] to the name\n */\n hi: function(to) {},\n\n /*\n Say goodbye\n @param [String] to the name\n */\n goodbye: function(to) {}\n}" }, { "file": "spec/_templates/mixins/concern.coffee", "name": "hi", "bound": false, "documentation": { "comment": "Say hi", "summary": "Say hi", "params": [ { "type": "String", "name": "to", "description": "the name" } ] }, "parameters": [ { "name": "to", "splat": false } ] }, { "file": "spec/_templates/mixins/concern.coffee", "name": "goodbye", "bound": false, "documentation": { "comment": "Say goodbye", "summary": "Say goodbye", "params": [ { "type": "String", "name": "to", "description": "the name" } ] }, "parameters": [ { "name": "to", "splat": false } ] }, { "file": "spec/_templates/mixins/concern.coffee", "documentation": { "comment": "", "summary": "", "concerns": [ "Example.Mixins.Concern" ] }, "name": "Example.Concern", "methods": [], "variables": [], "properties": [], "includes": [], "extends": [], "concerns": [ { "file": "spec/_templates/mixins/concern.coffee", "name": "Example.Mixins.Concern", "concern": true, "documentation": { "comment": "This is my concern", "summary": "This is my concern" }, "methods": [], "classMethods": [ { "file": "spec/_templates/mixins/concern.coffee", "name": "a", "bound": false, "documentation": { "comment": "", "summary": "", "params": [ { "type": "String", "name": "a", "description": "This is the a parameter" }, { "type": "String", "name": "b", "description": "This is the a parameter" }, { "type": "String", "name": "c", "description": "This is the a parameter" } ] }, "parameters": [ { "name": "a", "splat": false }, { "name": "b", "splat": false }, { "name": "c", "splat": false } ] }, { "file": "spec/_templates/mixins/concern.coffee", "name": "z", "bound": false, "documentation": { "comment": "", "summary": "", "params": [ { "type": "String", "name": "x", "description": "This is the x parameter" }, { "type": "String", "name": "y", "description": "This is the y parameter" }, { "type": "String", "name": "z", "description": "This is the z parameter" } ] }, "parameters": [ { "name": "x", "splat": false }, { "name": "y", "splat": false }, { "name": "z", "splat": false } ] } ], "instanceMethods": [ { "file": "spec/_templates/mixins/concern.coffee", "name": "hi", "bound": false, "documentation": { "comment": "Say hi", "summary": "Say hi", "params": [ { "type": "String", "name": "to", "description": "the name" } ] }, "parameters": [ { "name": "to", "splat": false } ] }, { "file": "spec/_templates/mixins/concern.coffee", "name": "goodbye", "bound": false, "documentation": { "comment": "Say goodbye", "summary": "Say goodbye", "params": [ { "type": "String", "name": "to", "description": "the name" } ] }, "parameters": [ { "name": "to", "splat": false } ] } ], "variables": [] } ] } ]