Add JavaDoc for new classes

marcauberer · Feb 3, 2021 · a352f13 · a352f13
1 parent e8b5db9
commit a352f13
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/simplesettings/src/main/java/com/chillibits/simplesettings/core/PreferenceElement.kt b/simplesettings/src/main/java/com/chillibits/simplesettings/core/PreferenceElement.kt
@@ -2,7 +2,10 @@ package com.chillibits.simplesettings.core
 
 import android.content.Context
 
-open class PreferenceElement(
+/**
+ * Base preference element, designed to be inherited from
+ */
+abstract class PreferenceElement(
         val context: Context,
         val iconSpaceReserved: Boolean
 )
diff --git a/simplesettings/src/main/java/com/chillibits/simplesettings/core/PreferenceHeader.kt b/simplesettings/src/main/java/com/chillibits/simplesettings/core/PreferenceHeader.kt
@@ -3,6 +3,10 @@ package com.chillibits.simplesettings.core
 import android.content.Context
 import androidx.annotation.LayoutRes
 
+/**
+ * Page element for page headers / setting screen headers.
+ * More information: https://github.com/marcauberer/simple-settings/wiki/PreferenceHeader
+ */
 class PreferenceHeader(
         context: Context,
         iconSpaceReservedByDefault: Boolean