From c10281488851f4f88a04847b9063a323d2d1fc01 Mon Sep 17 00:00:00 2001 From: Laurent Date: Wed, 20 Feb 2019 09:33:07 +0100 Subject: [PATCH 1/2] added comments --- .../android/ui/view/RowRepresentable.kt | 23 +++++++++++++++---- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/app/src/main/java/net/pokeranalytics/android/ui/view/RowRepresentable.kt b/app/src/main/java/net/pokeranalytics/android/ui/view/RowRepresentable.kt index 088e250c..91179ded 100644 --- a/app/src/main/java/net/pokeranalytics/android/ui/view/RowRepresentable.kt +++ b/app/src/main/java/net/pokeranalytics/android/ui/view/RowRepresentable.kt @@ -7,6 +7,18 @@ import net.pokeranalytics.android.ui.fragment.components.bottomsheet.BottomSheet interface RowRepresentable { + + /** + * The resource identifier of the localized title + */ + val resId: Int? + get() { + return null + } + + /** + * The localized title of the row + */ fun localizedTitle(context: Context): String { this.resId?.let { return context.getString(it) @@ -14,16 +26,17 @@ interface RowRepresentable { return "LOCALISATION NOT FOUND" } - val resId: Int? - get() { - return null - } - + /** + * The type of view associated with the row + */ val viewType: Int get() { return 0 } + /** + * The type of bottom sheet displayed when the row is clicked on + */ val bottomSheetType: BottomSheetType get() { return BottomSheetType.NONE From 6fef3aab3bf8151a6968719a42240547d15472d2 Mon Sep 17 00:00:00 2001 From: Laurent Date: Wed, 20 Feb 2019 09:34:52 +0100 Subject: [PATCH 2/2] added comment --- .../net/pokeranalytics/android/ui/view/RowRepresentable.kt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/app/src/main/java/net/pokeranalytics/android/ui/view/RowRepresentable.kt b/app/src/main/java/net/pokeranalytics/android/ui/view/RowRepresentable.kt index 91179ded..d54d5745 100644 --- a/app/src/main/java/net/pokeranalytics/android/ui/view/RowRepresentable.kt +++ b/app/src/main/java/net/pokeranalytics/android/ui/view/RowRepresentable.kt @@ -5,7 +5,10 @@ import net.pokeranalytics.android.R import net.pokeranalytics.android.model.LiveData import net.pokeranalytics.android.ui.fragment.components.bottomsheet.BottomSheetType - +/** + * An interface used so that enums values can be represented visually + * as rows in RecyclerViews + */ interface RowRepresentable { /**