Skip to content
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

Add cross-linking to documentation #2

Closed
wants to merge 2 commits into from
+12 −2
Closed

Add cross-linking to documentation #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5651c6c
Add cross-linking information
kamranayub Apr 2, 2015
0d77898
Merge pull request #1 from kamranayub/kamranayub-patch-1
kamranayub Apr 2, 2015
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
14 changes: 12 additions & 2 deletions src/docs/documents/guides/doccomments.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,18 @@ like classes, enumerations or property types and access modifiers will be automa

All comments are parsed as markdown. TypeDoc uses the Marked (https://github.com/chjj/marked) markdown parser
and HighlightJS (https://github.com/isagalaev/highlight.js) to highlight code blocks within markdown sections.
Additionally you can link to other classes, members or functions using double angle brackets.

## Cross-Linking

You can link to other classes, objects, and symbols using double brackets (`[[x]]`).

```typescript
/**
* An alias for [[Foobar.test2]]
* @param foo See [[Foobar]] for more details
*/
public function test(foo: any) { }
```

## JavaDoc tags

Expand Down Expand Up @@ -91,4 +101,4 @@ ensure that the first declaration also has as doc comment.
* This is a doc comment for "someVar".
*/
var someVar:string = "value";
```
```