Skip to content

Document why docstringMap is useful #10579

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

Merged
merged 1 commit into from
Dec 1, 2020
Merged

Document why docstringMap is useful #10579

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion compiler/src/dotty/tools/dotc/parsing/Scanners.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,12 @@ object Scanners {
error(s"illegal combination of -rewrite targets: ${enabled(0).name} and ${enabled(1).name}")
}

/** All doc comments kept by their end position in a `Map` */
/** All doc comments kept by their end position in a `Map`.
*
* Note: the map is necessary since the comments are looked up after an
* entire definition is parsed, and a definition can contain nested
* definitions with their own docstrings.
*/
private var docstringMap: SortedMap[Int, Comment] = SortedMap.empty

/* A Buffer for comment positions */
Expand Down