diff --git a/test/fixture/typedef.input.js b/test/fixture/typedef.input.js new file mode 100644 index 000000000..2747c8de7 --- /dev/null +++ b/test/fixture/typedef.input.js @@ -0,0 +1,8 @@ +/** + * A type definition. + * @name MyType + * @typedef {Object} MyType + * @property {number} prop1 - one property + * @property {string} prop2 - another property + */ + diff --git a/test/fixture/typedef.output.custom.md b/test/fixture/typedef.output.custom.md new file mode 100644 index 000000000..d498f7ca1 --- /dev/null +++ b/test/fixture/typedef.output.custom.md @@ -0,0 +1,6 @@ +## `MyType` + +A type definition. + + + diff --git a/test/fixture/typedef.output.json b/test/fixture/typedef.output.json new file mode 100644 index 000000000..f93a67f01 --- /dev/null +++ b/test/fixture/typedef.output.json @@ -0,0 +1,93 @@ +[ + { + "description": "A type definition.", + "tags": [ + { + "title": "name", + "description": null, + "lineNumber": 2, + "name": "MyType" + }, + { + "title": "typedef", + "description": "MyType", + "lineNumber": 3, + "type": { + "type": "NameExpression", + "name": "Object" + } + }, + { + "title": "property", + "description": "one property", + "lineNumber": 4, + "type": { + "type": "NameExpression", + "name": "number" + }, + "name": "prop1" + }, + { + "title": "property", + "description": "another property", + "lineNumber": 5, + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "prop2" + }, + { + "title": "kind", + "kind": "typedef" + } + ], + "loc": { + "start": { + "line": 1, + "column": 0 + }, + "end": { + "line": 7, + "column": 3 + } + }, + "context": { + "loc": { + "start": { + "line": 9, + "column": 0 + }, + "end": { + "line": 9, + "column": 0 + } + }, + "file": "fixture/typedef.input.js" + }, + "name": "MyType", + "properties": [ + { + "title": "property", + "description": "one property", + "lineNumber": 4, + "type": { + "type": "NameExpression", + "name": "number" + }, + "name": "prop1" + }, + { + "title": "property", + "description": "another property", + "lineNumber": 5, + "type": { + "type": "NameExpression", + "name": "string" + }, + "name": "prop2" + } + ], + "kind": "typedef" + } +] \ No newline at end of file diff --git a/test/fixture/typedef.output.md b/test/fixture/typedef.output.md new file mode 100644 index 000000000..773468032 --- /dev/null +++ b/test/fixture/typedef.output.md @@ -0,0 +1,13 @@ +## `MyType` + +A type definition. + + +| name | type | description | +| ---- | ---- | ----------- | +| `prop1` | `number` | one property | +| `prop2` | `string` | another property | + + + +