Fix for sorting directives with documentation comments.

Fix for sorting directives with documentation comments.

Stop trying to keep non-documentation directive comments after sorting.

R=brianwilkerson@google.com
BUG=

Committed: https://github.com/dart-lang/sdk/commit/582c0389403472d5b773316c3f89b646f33c777f

[Brian Wilkerson, 2016-03-29 20:12:57]

There's one small wrinkle here. If this:

/// library comment
import 'b.dart';
import 'a.dart';

would become this:

import 'b.dart';
/// library comment
import 'a.dart';

then the library comment is no longer a library comment. (I *knew* it would
cause problems to tie the library comment to the first directive.)

https://codereview.chromium.org/1843763002/diff/1/pkg/analysis_server/lib/src...
File pkg/analysis_server/lib/src/services/correction/sort_members.dart (left):

https://codereview.chromium.org/1843763002/diff/1/pkg/analysis_server/lib/src...
pkg/analysis_server/lib/src/services/correction/sort_members.dart:231: // append
comment tokens which otherwise would be removed completely
Does this imply that other comments will be removed? I don't think that's
reasonable, but it's probably a lower probability bug than the current one.

[scheglov, 2016-03-29 20:58:16]

On 2016/03/29 20:12:57, Brian Wilkerson wrote:
> There's one small wrinkle here. If this:
> 
> /// library comment
> import 'b.dart';
> import 'a.dart';
> 
> would become this:
> 
> import 'b.dart';
> /// library comment
> import 'a.dart';
> 
> then the library comment is no longer a library comment. (I *knew* it would
> cause problems to tie the library comment to the first directive.)

Hm...
What if we have documentation comments for both - first and second imports and
we need to exchange them during sorting?
What is considered a library comment - the first comment of the first directive,
or the last comment of the first directive?

[Brian Wilkerson, 2016-03-29 23:17:38]

> What if we have documentation comments for both - first and second imports and
> we need to exchange them during sorting?

Good question. The assumption when we decided to allow the library comment to be
associated with any directive is that directives will almost never exist. I
don't know what the right answer is, but it seems like the comment on the first
directive is special because it's being interpreted as the library comment.

> What is considered a library comment - the first comment of the first
directive,
> or the last comment of the first directive?

The library comment is the documentation comment associated with the first
directive. Every directive can have at most one documentation comment, which is
the most immediately preceding comment. Hence:

/** not associated with anything */
/** library comment */
import 'b.dart';

[scheglov, 2016-03-30 20:53:42]

PTAL

[Brian Wilkerson, 2016-03-30 23:16:51]

LGTM

[scheglov, 2016-03-31 00:21:33]

Description was changed from

==========
Fix for sorting directives with documentation comments.

Stop trying to keep non-documentation directive comments after sorting.

R=brianwilkerson@google.com
BUG=
==========

to

==========
Fix for sorting directives with documentation comments.

Stop trying to keep non-documentation directive comments after sorting.

R=brianwilkerson@google.com
BUG=

Committed:
https://github.com/dart-lang/sdk/commit/582c0389403472d5b773316c3f89b646f33c777f
==========

[scheglov, 2016-03-31 00:21:34]

Committed patchset #2 (id:20001) manually as
582c0389403472d5b773316c3f89b646f33c777f (presubmit successful).