Skip to content

feat(markdown): Add @see tag output in Markdown #682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 24, 2017
Merged

feat(markdown): Add @see tag output in Markdown #682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion declarations/comment.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ declare type Comment = {
params: Array<CommentTag>,
properties: Array<CommentTag>,
returns: Array<CommentTag>,
sees: Array<CommentTag>,
sees: Array<Remark>,
throws: Array<CommentTag>,
todos: Array<CommentTag>,

Expand Down
11 changes: 11 additions & 0 deletions lib/output/markdown_ast.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,16 @@ function buildMarkdownAST(comments/*: Array<Comment> */, config/*: Documentation
]);
}

function seeLink(comment/*: Comment */) {
return comment.sees.length > 0 && u('list', { ordered: false }, comment.sees.map(see =>
u('listItem', [
u('strong', [
u('text', 'See: ')
].concat(see.children))
])
));
}

function githubLink(comment/*: Comment */) {
return comment.context && comment.context.github && u('paragraph', [
u('link', {
Expand Down Expand Up @@ -204,6 +214,7 @@ function buildMarkdownAST(comments/*: Array<Comment> */, config/*: Documentation
return [u('heading', { depth }, [u('text', comment.name || '')])]
.concat(githubLink(comment))
.concat(augmentsLink(comment))
.concat(seeLink(comment))
.concat(comment.description ? comment.description.children : [])
.concat(typeSection(comment))
.concat(paramSection(comment))
Expand Down
3 changes: 3 additions & 0 deletions test/fixture/meta.input.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
/**
* This function returns the number one.
* @returns {number} numberone
* @see {@link http://github.com/|github}
* @see TestCase
* @see [markdown link](http://foo.com/)
* @version 1.0.0
* @since 2.0.0
* @copyright Tom MacWright
Expand Down
216 changes: 208 additions & 8 deletions test/fixture/meta.output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,25 +62,40 @@
"name": "number"
}
},
{
"title": "see",
"description": "{@link http://github.com/|github}",
"lineNumber": 3
},
{
"title": "see",
"description": "TestCase",
"lineNumber": 4
},
{
"title": "see",
"description": "[markdown link](http://foo.com/)",
"lineNumber": 5
},
{
"title": "version",
"description": "1.0.0",
"lineNumber": 3
"lineNumber": 6
},
{
"title": "since",
"description": "2.0.0",
"lineNumber": 4
"lineNumber": 7
},
{
"title": "copyright",
"description": "Tom MacWright",
"lineNumber": 5
"lineNumber": 8
},
{
"title": "license",
"description": "BSD",
"lineNumber": 6
"lineNumber": 9
}
],
"loc": {
Expand All @@ -89,18 +104,18 @@
"column": 0
},
"end": {
"line": 8,
"line": 11,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 9,
"line": 12,
"column": 0
},
"end": {
"line": 12,
"line": 15,
"column": 2
}
}
Expand Down Expand Up @@ -171,7 +186,192 @@
}
}
],
"sees": [],
"sees": [
{
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"url": "http://github.com/",
"title": null,
"jsdoc": true,
"children": [
{
"type": "text",
"value": "github"
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 34,
"offset": 33
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 34,
"offset": 33
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 34,
"offset": 33
}
}
},
{
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "TestCase",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 9,
"offset": 8
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 9,
"offset": 8
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 9,
"offset": 8
}
}
},
{
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "http://foo.com/",
"children": [
{
"type": "text",
"value": "markdown link",
"position": {
"start": {
"line": 1,
"column": 2,
"offset": 1
},
"end": {
"line": 1,
"column": 15,
"offset": 14
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 33,
"offset": 32
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 33,
"offset": 32
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 33,
"offset": 32
}
}
}
],
"throws": [],
"todos": [],
"version": "1.0.0",
Expand Down
4 changes: 4 additions & 0 deletions test/fixture/meta.output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

## meta.input

- **See: [github](http://github.com/)**
- **See: TestCase**
- **See: [markdown link](http://foo.com/)**

This function returns the number one.

Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** numberone
Expand Down
Loading