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.

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

Support for doc comments on same line. #12803

Closed
DartBot opened this issue Aug 27, 2013 · 12 comments
Closed

Support for doc comments on same line. #12803

DartBot opened this issue Aug 27, 2013 · 12 comments
Labels
area-language Dart language related items (some items might be better tracked at github.com/dart-lang/language). closed-not-planned Closed as we don't intend to take action on the reported issue P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug

Comments

@DartBot
Copy link

DartBot commented Aug 27, 2013

This issue was originally filed by pixe...@gmail.com


Hi, Would be nice to be able to document code like this:

class MyClass {
    int id; /// Doc comment for id
    String name; /// Doc comment for name
    String description; /// Doc comment for description
    String otherValue; /// Doc comment for otherValue
}

Instead of:

class MyClass {
    /// Doc comment for id
    int id;
    
    /// Doc comment for name
    String name;
    
    /// Doc comment for description
    String description;
    
    /// Doc comment for otherValue
    String otherValue;
}

@iposva-google
Copy link
Contributor

Added Area-DartDoc, Triaged labels.

@anders-sandholm
Copy link
Contributor

Added old-dartdoc label.

@alan-knight
Copy link
Contributor

Removed Priority-Unassigned, old-dartdoc labels.
Added Priority-Low label.

@alan-knight
Copy link
Contributor

Removed Type-Defect label.
Added Type-Enhancement label.

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

Added Pkg-DartDoc label.

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

Removed Area-DartDoc label.
Added Area-Pkg label.

@kevmoo
Copy link
Member

kevmoo commented Apr 7, 2014

Removed Pkg-DartDoc label.
Added Pkg-DocGen label.

@sethladd
Copy link
Contributor

Thanks for the suggestion! We looked at the spec, and the spec defines how to connect a doc comment and the thing it's describing. If you're like to pursue this, it would take a spec change. I'm reclassifying this request as a Language request.


Removed Area-Pkg, Pkg-DocGen labels.
Added Area-Language label.

@DartBot DartBot added Type-Enhancement P3 A lower priority bug or feature request area-language Dart language related items (some items might be better tracked at github.com/dart-lang/language). labels Jan 12, 2015
@kevmoo kevmoo added type-enhancement A request for a change that isn't a bug and removed triaged labels Feb 29, 2016
@munificent
Copy link
Member

munificent commented Dec 15, 2016

I don't think the spec should be in the business of defining doc comments.

How about we remove that from the spec and then kick this over to dartdoc?

cc @lrhn @floitschG @eernstg @leafpetersen

@natebosch
Copy link
Member

This isn't something we've had continued demand for. Doc comments which are short enough to fit on the same are unlikely to add new information over the type and name so I'd think most of them can be omitted anyway.

Is there value in keeping this open?

@kevmoo
Copy link
Member

kevmoo commented Aug 23, 2018

My vote: close

@natebosch
Copy link
Member

Closing. If there is renewed interest in this proposal please add a comment and we can reopen.

@natebosch natebosch added the closed-not-planned Closed as we don't intend to take action on the reported issue label Aug 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-language Dart language related items (some items might be better tracked at github.com/dart-lang/language). closed-not-planned Closed as we don't intend to take action on the reported issue P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

8 participants