read comments from fields of anonymous structs #32
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for reading documentation comments from fields of anonymous structs. The code keeps track of what fields it has traversed, and builds up a breadcrumb that includes every parent field.
Consider the following fields:
These fields will, respectively, have the following breadcrumbs, used (along with the fully qualified name of the package) as the key in the comments map:
A.Val1
A.Val2.StructVal
A.Val3.[].SliceVal
A.Val4.[key].MapKeyVal
A.Val4.[value].MapValueVal
Note that any time the code encounters a non-anonymous type, it resets the breadcrumb to the type's fully qualified name.
Tested with a decently large codebase.