Display translations using documentation comments #52
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.
What type of PR is this ?
Feature
What was added ?
I added two new options for configuration in the pubspec.yaml
What they do, is adding documentation comments to the getters, containing the translations for it, like this
The reason for this is, that it then uses these comments in your IDE, like VSCode and you can directly see the content of the translation
The
comment_languages
key can be used to limit the amount of translations that are put into the comments.If, for example, you have 20 translations, but you only wanna see the translations of your native language and english, you can define it as:
And then only translations from these languages are put into the comments.
Where tests added ?
Yes, I added tests to cover the code i modified and added.
I ran all the tests and they were all successful.