codo
Version:
A CoffeeScript documentation generator.
96 lines • 2.88 kB
JSON
[
{
"file": "spec/_templates/methods/dynamic_methods.coffee",
"methods": [],
"variables": []
},
{
"file": "spec/_templates/methods/dynamic_methods.coffee",
"documentation": {
"comment": "This class has virtual methods, which doesn't\nexist in the source but appears in the documentation.\n\nThis line should be part of the class description, and the method declaration\nshouldn't have messed it up.",
"summary": "This class has virtual methods, which doesn't\nexist in the source but appears in the documentation.",
"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"
}
},
{
"signature": ".get(key)",
"documentation": {
"params": [
{
"type": "String",
"name": "key",
"description": "describe key param"
}
],
"returns": {
"type": "Object",
"description": "describe value param"
},
"comment": "Gets a value",
"summary": "Gets a value"
}
},
{
"signature": "#delete({key, passion}, foo='bar')",
"documentation": {
"params": [
{
"type": "String",
"name": "key",
"description": "describe key param"
}
],
"examples": [
{
"title": "Delete a key.",
"code": "emv = new Example.Methods.Virtual\nemv.set 'foo', 'bar'\nval = emv.get 'foo'\n\n# now, proclaim you're done with foo.\nemv.delete 'foo'"
}
],
"comment": "Deletes a key from the data.\n\nAnother line",
"summary": "Deletes a key from the data."
}
}
]
},
"name": "Example.Methods.Virtual",
"methods": [],
"variables": [],
"properties": [],
"includes": [],
"extends": [],
"concerns": []
}
]