Fix issue with generating docs for embedded structures with alias instead of package name #668
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.
Issue
For example, there's a package
github.com/user/repo/common
which contains typeCommon
:If we embed this type in another struct but use an alias instead of the real package name, swag will generate wrong documentation:
Generated documentation:
Solution
We can suppose that
pkgName
is a package alias, iftypeSpec
isnil
. So, we can just iterate through import aliases and check can we get non-niltypeSpec