biscotto - npm Package Compare versions

spec/templates/methods/method_delegation.coffee

spec/templates/methods/method_delegation.json

spec/templates/methods/method_paragraph_param.coffee

spec/templates/methods/method_paragraph_param.json

2

package.json

		@@ -11,3 +11,3 @@ {
		],
		"version" : "0.0.10",
		"version" : "0.0.11",
		"engines" : {
		@@ -14,0 +14,0 @@ "node" : ">=0.8.0"

51

README.md

		@@ -27,4 +27,17 @@ Biscotto is a [CoffeeScript](http://coffeescript.org/) API documentation generator. The underlying architecture is based on [codo](https://github.com/netzpirat/codo); however, this uses [TomDoc](http://tomdoc.org/) notation, instead of JSDoc.
		Each method argument starts with the argument name, followed by a dash (`-`), and
		the description of the argument. Hash options are placed on a newline and preceded
		with a colon (`:`). If a description has a default value, define it at the end of the
		the description of the argument:

		```
		argument - Some word about the arg!
		```

		Hash options are placed on a newline and end with a colon:

		```
		options - These are the options:
		key1: Blah blah.
		key2: Blah
		```

		If a description has a default value, define it at the end of the
		description with `(default: <desc>)`.
		@@ -38,5 +51,5 @@
		Methods without return types returned `undefined`. You can list more than one `Returns`
		per method by seperating each type on a different line.
		per method by separating each type on a different line.

		### Block Flagging Statuses
		### Status Blocks

		@@ -93,2 +106,32 @@ You can flag methods in a file with the following syntax:

		### Delegation

		If you're writing methods that do the exact same thing as another method, you can
		choose to copy over the documentation via _delegation_. For example:

		```coffee
		# {Delegates to: .delegatedRegular}
		delegatedMethod: ->

		# Public: I'm being delegated to!
		#
		# a - A {Number}
		# b - A {String}
		#
		# Returns a {Boolean}
		delegatedRegular: (a, b) ->
		```

		`delegatedMethod` has the same arguments, return type, and documentation as
		`delegatedRegular`. You can also choose to delegate to a different class:

		```coffee
		# Private: {Delegates to: Another.Class@somewhere}
		delegatedMethod: ->
		```

		Classes that are delegated should still set their own statuses. For example, if
		`Another.Class@somewhere` is Public, `delegatedMethod` is still marked as `Private`.
		The same documentation remains.

		### Examples
		@@ -95,0 +138,0 @@

12

spec/templates/methods/curly_method_documentation.json

		@@ -10,4 +10,4 @@ [
		"class": {
		"className": "App.TestMethodDocumentation",
		"name": "TestMethodDocumentation",
		"className": "App.CurlyMethodDocumentation",
		"name": "CurlyMethodDocumentation",
		"namespace": "App",
		@@ -37,4 +37,4 @@ "parent": "App.Doc"
		"doc": {
		"comment": "<p>Do it!</p><p>See #undo for more information.</p>",
		"summary": "Do it! See #undo for more information.",
		"comment": "<p>Do it!</p><p>See {#undo} for more information.</p>",
		"summary": "Do it! See {#undo} for more information.",
		"status": "Private",
		@@ -134,4 +134,4 @@ "params": [
		"doc": {
		"comment": "<p>Do it!</p><p>See .do for more information.</p>",
		"summary": "Do it! See .do for more information.",
		"comment": "<p>Do it!</p><p>See {.do} for more information.</p>",
		"summary": "Do it! See {.do} for more information.",
		"status": "Private"
		@@ -138,0 +138,0 @@ },

172

spec/templates/methods/hash_parameters.json

		[
		{
		"file": "spec/templates/methods/hash_parameters.coffee",
		"doc": {
		"comment": "",
		"summary": "",
		"status": "Public"
		},
		"class": {
		"className": "TestInstanceMethods",
		"name": "TestInstanceMethods",
		"namespace": ""
		},
		"methods": [
		{
		{
		"file": "spec/templates/methods/hash_parameters.coffee",
		"doc": {
		"comment": "",
		"summary": "",
		"status": "Public"
		"comment": "",
		"summary": "",
		"status": "Public"
		},
		"type": "instance",
		"signature": ".<strong>helper</strong>()",
		"name": "helper",
		"bound": false,
		"parameters": []
		},
		{
		"doc": {
		"comment": "<p>Does something.</p>",
		"summary": "Does something.",
		"status": "Public",
		"params": [
		"class": {
		"className": "TestInstanceMethods",
		"name": "TestInstanceMethods",
		"namespace": ""
		},
		"methods": [
		{
		"name": "obj",
		"desc": "An object with the following defaults:",
		"type": "",
		"options": [
		{
		"name": "aaa",
		"desc": "Does some stuff",
		"type": ""
		"doc": {
		"comment": "",
		"summary": "",
		"status": "Public"
		},
		{
		"name": "bbb",
		"desc": "Does some {Integer} stuff",
		"type": "Integer"
		"type": "instance",
		"signature": ".<strong>helper</strong>()",
		"name": "helper",
		"bound": false,
		"parameters": []
		},
		{
		"doc": {
		"comment": "<p>Does something.</p>",
		"summary": "Does something.",
		"status": "Public",
		"params": [
		{
		"name": "obj",
		"desc": "An object with the following defaults:",
		"type": "",
		"options": [
		{
		"name": "aaa",
		"desc": "Does some stuff",
		"type": ""
		},
		{
		"name": "bbb",
		"desc": "Does some {Integer} stuff",
		"type": "Integer"
		},
		{
		"name": "ccc",
		"desc": "Other stuff",
		"type": ""
		}
		]
		}
		]
		},
		{
		"name": "ccc",
		"desc": "Other stuff",
		"type": ""
		}
		]
		"type": "instance",
		"signature": ".<strong>someMethod</strong>(obj = {})",
		"name": "someMethod",
		"bound": false,
		"parameters": [
		{
		"name": "obj",
		"default": "{}",
		"splat": false
		}
		]
		},
		{
		"doc": {
		"comment": "<p>Does something else.</p>",
		"summary": "Does something else.",
		"status": "Public",
		"params": [
		{
		"name": "obj",
		"desc": "An object with some defaults. Those defaults are nice! Here are some of those defaults:",
		"type": "",
		"options": [
		{
		"name": "aaa",
		"desc": "Does some {String} stuff",
		"type": "String"
		},
		{
		"name": "bbb",
		"desc": "Does some {Integer} stuff",
		"type": "Integer"
		},
		{
		"name": "ccc",
		"desc": "Other stuff",
		"type": ""
		}
		]
		}
		]
		},
		"type": "instance",
		"signature": ".<strong>someMethod</strong>(obj = {})",
		"name": "someMethod",
		"bound": false,
		"parameters": [
		{
		"name": "obj",
		"default": "{}",
		"splat": false
		}
		]
		}
		]
		},
		"type": "instance",
		"signature": ".<strong>someMethod</strong>(obj = {})",
		"name": "someMethod",
		"bound": false,
		"parameters": [
		{
		"name": "obj",
		"default": "{}",
		"splat": false
		}
		]
		}
		],
		"variables": [],
		"properties": []
		}
		],
		"variables": [],
		"properties": []
		}
		]

4

spec/templates/methods/return_values_long.json

		@@ -10,4 +10,4 @@ [
		"class": {
		"className": "App.TestMethodDocumentation",
		"name": "TestMethodDocumentation",
		"className": "App.ReturnValuesLongDocumentation",
		"name": "ReturnValuesLongDocumentation",
		"namespace": "App",
		@@ -14,0 +14,0 @@ "parent": "App.Doc"

4

spec/templates/methods/return_values.json

		@@ -10,4 +10,4 @@ [
		"class": {
		"className": "App.TestMethodDocumentation",
		"name": "TestMethodDocumentation",
		"className": "App.ReturnValsDocumentation",
		"name": "ReturnValsDocumentation",
		"namespace": "App",
		@@ -14,0 +14,0 @@ "parent": "App.Doc"

spec/parser_spec.coffee