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

Jump to bottom

Correct way to reference null, true, false, etc in doc comments #16193

Closed
kevmoo opened this issue Jan 18, 2014 · 3 comments
Closed

Correct way to reference null, true, false, etc in doc comments #16193

kevmoo opened this issue Jan 18, 2014 · 3 comments
Labels
area-documentation Prefer using 'type-documentation' and a specific area label. type-documentation A request to add or improve documentation

Comments

@kevmoo
Copy link
Member

kevmoo commented Jan 18, 2014

I see true and [:true:] in the dart code.

The guidelines mention both https://www.dartlang.org/articles/doc-comment-guidelines/

I've used just [true] in a number of places.

Are these reasoned about differently in DartDoc? Does it matter?
@lrhn
Copy link
Member

lrhn commented Jan 18, 2014

Either true or [:true:] works. They mean the same thing.

Using [true] is incorrect. The content between [ and ] must refer to a declaration in scope of the reference. DartDoc will turn it into a link to the declaration.
There is no declaration for [true](it's a literal, not a variable), so writing [true] is incorrect (as is [this], btw.).

@kevmoo
Copy link
Member Author

kevmoo commented Jan 19, 2014

See https://codereview.chromium.org/140783013

Added Started label.

@kevmoo
Copy link
Member Author

kevmoo commented Jan 19, 2014

r31947

Added Fixed label.

@kevmoo kevmoo added type-documentation A request to add or improve documentation Priority-Unassigned area-documentation Prefer using 'type-documentation' and a specific area label. labels Jan 19, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-documentation Prefer using 'type-documentation' and a specific area label. type-documentation A request to add or improve documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kevmoo @lrhn