utils/dartdoc/README.txt - Issue 8772067: Navigation in generated docs.

Side by Side Diff

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Keyboard Shortcuts

	File
u :	up to issue
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line

	Issue
u :	up to list of issues
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue

Side by Side Diff: utils/dartdoc/README.txt

Issue 8772067: Navigation in generated docs. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: Respond to review. Created 9 years ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

« no previous file with comments | « no previous file | utils/dartdoc/dartdoc » ('j') | no next file with comments »

OLD	NEW
1 Dartdoc generates static HTML documentation from Dart code.	1 Dartdoc generates static HTML documentation from Dart code.

2	2

3 To use it, from this directory, run:	3 To use it, from this directory, run:

4	4

5 $ dartdoc <path to .dart file>	5 $ dartdoc <path to .dart file>

6	6

7 This will create a "docs" directory with the docs for your libraries.	7 This will create a "docs" directory with the docs for your libraries.

8	8

9	9

10 How docs are generated	10 How docs are generated

(...skipping 57 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
68	68

69 There is also an extension to markdown specific to dartdoc: A name inside	69 There is also an extension to markdown specific to dartdoc: A name inside

70 square brackets that is not a markdown link (i.e. doesn't have square brackets	70 square brackets that is not a markdown link (i.e. doesn't have square brackets

71 or parentheses following it) like:	71 or parentheses following it) like:

72	72

73 Calls [someMethod], passing in [arg].	73 Calls [someMethod], passing in [arg].

74	74

75 is understood to be the name of some member or type that's in the scope of the	75 is understood to be the name of some member or type that's in the scope of the

76 member where that comment appears. Dartdoc will automatically figure out what	76 member where that comment appears. Dartdoc will automatically figure out what

77 the name refers to and generate an approriate link to that member or type.	77 the name refers to and generate an approriate link to that member or type.

	78

	79

	80 Attribution

	81 -----------

	82

	83 dartdoc uses the delightful Silk icon set by Mark James.

	84 http://www.famfamfam.com/lab/icons/silk/

OLD	NEW