JavaDoc for PracticeList, Issue #47

This commit is contained in:
osp1 2020-05-01 13:33:53 +01:00
parent d11b4579d4
commit 1c9e73be8e

View file

@ -58,7 +58,10 @@ public class PracticeListController extends SharedCodeController {
public ObservableList<DictionaryEntry> list = FXCollections.observableArrayList();
/**
*
* Method to switch the language used to sort the dictionary list.
* <p>
* If currently sorted by English, this will change the sort to by Welsh.
* If currently sorted by Welsh, this will change the sort to by English.
*/
@FXML
private void switchLangSort() {
@ -91,7 +94,10 @@ public class PracticeListController extends SharedCodeController {
}
/**
*
* Method to switch the alphabetical order used to sort the dictionary list.
* <p>
* If currently sorted by A-Z, this will change the sort to by Z-A.
* If currently sorted by Z-A, this will change the sort to by A-Z.
*/
@FXML
private void switchAlphaSort() {
@ -116,13 +122,10 @@ public class PracticeListController extends SharedCodeController {
/**
* Initializes the table of dictionary entries.
* Initializes the table of dictionary entries.
* <p>
* An observable list of DictionaryEntries is loaded from the Application class into a local instance of ObservableList.
* It also sets up Lambda expressions related to live searching functionality and the display of DictionaryEntries.
* <p>
* // * @param url
* // * @param resourceBundle
*
* @see Application
* @see DictionaryEntry