Add JavaDoc to ComboBox#65
Open
ChrisChros123 wants to merge 1 commit into
Open
Conversation
yamass
reviewed
Jan 6, 2022
| import java.util.stream.Collectors; | ||
|
|
||
| /** | ||
| * A combo box is a drop-down list which can be expanded by pressing a button. It includes a text field |
Member
There was a problem hiding this comment.
A combo box is a drop-down list selection input with search functionality.
(I think, trying it says more than telling the whole story ;-) )
| * A combo box is a drop-down list which can be expanded by pressing a button. It includes a text field | ||
| * where the user can type in a search term. The list element chosen by the user is then shown in that field. | ||
| * | ||
| * A combo box instance can either be created using the constructor or the overloaded {@link #createForList(List)} method |
Member
There was a problem hiding this comment.
... or one of ComboBox's static factory methods.
(we might add more of these and forget to update the JavaDoc, so I think it makes sense to just hint to the fact that there are static factory methods and not describe the details of them here...)
| * The {@link org.teamapps.data.extract.PropertyProvider} or its specification, the PropertyExtractor, are used to map | ||
| * the template's property names to object specific information, e.g. its attributes, that should represent the record | ||
| * in the combo box. | ||
| */ |
Member
There was a problem hiding this comment.
Let's talk about how to improve this on the phone. I think we might want to keep one level of abstraction on the class documentation, giving a brief overview of the main concepts, and describe the details on the method level.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.