From f163ef8dfc1dfdf20c7e8ad91dda82c19e5d9d5d Mon Sep 17 00:00:00 2001 From: Andrew Tavis McAllister Date: Tue, 31 Dec 2024 17:23:27 +0100 Subject: [PATCH] Edit spacing of license note and remove unneeded files --- add_license.sh | 24 ------------------- .../be/scri/fragments/MainFragmentTest.kt | 7 +++--- app/src/main/java/be/scri/App.kt | 5 ++-- .../java/be/scri/activities/MainActivity.kt | 7 +++--- .../java/be/scri/adapters/ViewPagerAdapter.kt | 7 +++--- .../java/be/scri/extensions/CommonsContext.kt | 7 +++--- .../main/java/be/scri/extensions/Context.kt | 7 +++--- .../java/be/scri/extensions/ContextStyling.kt | 7 +++--- .../main/java/be/scri/extensions/Drawable.kt | 5 ++-- app/src/main/java/be/scri/extensions/Int.kt | 7 +++--- .../java/be/scri/extensions/RecyclerView.kt | 5 ++-- app/src/main/java/be/scri/extensions/View.kt | 7 +++--- .../java/be/scri/fragments/AboutFragment.kt | 7 +++--- .../fragments/LanguageSettingsFragment.kt | 7 +++--- .../java/be/scri/fragments/MainFragment.kt | 7 +++--- .../scri/fragments/PrivacyPolicyFragment.kt | 7 +++--- .../java/be/scri/fragments/ScribeFragment.kt | 7 +++--- .../be/scri/fragments/SettingsFragment.kt | 7 +++--- .../be/scri/fragments/ThirdPartyFragment.kt | 7 +++--- .../scri/fragments/WikimediaScribeFragment.kt | 7 +++--- .../be/scri/helpers/AlphanumericComparator.kt | 9 +++---- .../main/java/be/scri/helpers/BaseConfig.kt | 7 +++--- .../java/be/scri/helpers/CommonsConstants.kt | 7 +++--- app/src/main/java/be/scri/helpers/Config.kt | 7 +++--- .../main/java/be/scri/helpers/Constants.kt | 7 +++--- .../java/be/scri/helpers/CustomAdapter.kt | 7 +++--- .../java/be/scri/helpers/DatabaseHelper.kt | 7 +++--- .../main/java/be/scri/helpers/HintUtils.kt | 7 +++--- .../main/java/be/scri/helpers/MyKeyboard.kt | 7 +++--- .../java/be/scri/helpers/PreferencesHelper.kt | 7 +++--- .../main/java/be/scri/helpers/RatingHelper.kt | 7 +++--- .../main/java/be/scri/helpers/ShareHelper.kt | 7 +++--- .../helpers/english/ENInterfaceVariables.kt | 7 +++--- .../helpers/french/FRInterfaceVariables.kt | 7 +++--- .../helpers/german/DEInterfaceVariables.kt | 7 +++--- .../helpers/italian/ITInterfaceVariables.kt | 7 +++--- .../helpers/portugese/PTInterfaceVariables.kt | 7 +++--- .../helpers/russian/RUInterfaceVariables.kt | 7 +++--- .../helpers/spanish/ESInterfaceVariables.kt | 7 +++--- .../helpers/swedish/SVInterfaceVariables.kt | 7 +++--- .../java/be/scri/models/ItemsViewModel.kt | 7 +++--- .../main/java/be/scri/models/SwitchItem.kt | 7 +++--- app/src/main/java/be/scri/models/TextItem.kt | 7 +++--- .../be/scri/services/EnglishKeyboardIME.kt | 7 +++--- .../be/scri/services/FrenchKeyboardIME.kt | 7 +++--- .../be/scri/services/GermanKeyboardIME.kt | 7 +++--- .../be/scri/services/ItalianKeyboardIME.kt | 7 +++--- .../be/scri/services/PortugueseKeyboardIME.kt | 7 +++--- .../be/scri/services/RussianKeyboardIME.kt | 7 +++--- .../be/scri/services/SimpleKeyboardIME.kt | 7 +++--- .../be/scri/services/SpanishKeyboardIME.kt | 7 +++--- .../be/scri/services/SwedishKeyboardIME.kt | 7 +++--- .../ui/common/components/AboutPageItemComp.kt | 7 +++--- .../ui/common/components/ClickableItemComp.kt | 7 +++--- .../components/ComposeScaffoldContainer.kt | 7 +++--- .../ui/common/components/ItemCardContainer.kt | 7 +++--- .../components/ItemCardContainerWithTitle.kt | 7 +++--- .../common/components/SwitchableItemComp.kt | 5 ++-- .../main/java/be/scri/ui/models/ScribeItem.kt | 8 +++---- .../java/be/scri/ui/models/ScribeItemList.kt | 7 +++--- .../java/be/scri/ui/screens/AboutScreen.kt | 7 +++--- .../be/scri/ui/screens/InstallationScreen.kt | 7 +++--- .../scri/ui/screens/LanguageSettingsScreen.kt | 7 +++--- .../be/scri/ui/screens/PrivacyPolicyScreen.kt | 7 +++--- .../java/be/scri/ui/screens/SettingsScreen.kt | 7 +++--- .../be/scri/ui/screens/ThirdPartyScreen.kt | 7 +++--- .../be/scri/ui/screens/WikimediaScreen.kt | 7 +++--- app/src/main/java/be/scri/ui/theme/Colors.kt | 7 +++--- .../main/java/be/scri/ui/theme/ScribeTheme.kt | 7 +++--- .../main/java/be/scri/ui/theme/Typography.kt | 7 +++--- .../scri/views/CustomDividerItemDecoration.kt | 7 +++--- .../main/java/be/scri/views/MyKeyboardView.kt | 7 +++--- .../test/kotlin/fragments/MainFragmentTest.kt | 7 +++--- .../helpers/AlphanumericComparatorTest.kt | 7 +++--- license_template.txt | 18 -------------- 75 files changed, 289 insertions(+), 259 deletions(-) delete mode 100755 add_license.sh delete mode 100644 license_template.txt diff --git a/add_license.sh b/add_license.sh deleted file mode 100755 index 733f4966..00000000 --- a/add_license.sh +++ /dev/null @@ -1,24 +0,0 @@ -#!/bin/bash - -# Path to the license template -LICENSE_TEMPLATE="license_template.txt" - -# Iterate through all .kt files -find . -name "*.kt" | while read -r FILE; do - # Extract the file name and construct a description - FILE_NAME=$(basename "$FILE") - DESCRIPTION="This file contains the implementation for ${FILE_NAME%.kt}." - - # Create a temporary file with the updated license - TEMP_FILE=$(mktemp) - sed "s/{Description}/$DESCRIPTION/" "$LICENSE_TEMPLATE" > "$TEMP_FILE" - - # Add the license and the rest of the file - cat "$TEMP_FILE" "$FILE" > "${FILE}.new" - mv "${FILE}.new" "$FILE" - - # Clean up the temporary file - rm "$TEMP_FILE" - - echo "Updated: $FILE" -done diff --git a/app/src/androidTest/kotlin/be/scri/fragments/MainFragmentTest.kt b/app/src/androidTest/kotlin/be/scri/fragments/MainFragmentTest.kt index 53b5a556..1d2e9441 100644 --- a/app/src/androidTest/kotlin/be/scri/fragments/MainFragmentTest.kt +++ b/app/src/androidTest/kotlin/be/scri/fragments/MainFragmentTest.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for MainFragmentTest. + * Testing for MainFragment. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + import android.content.Context import android.content.SharedPreferences import androidx.appcompat.app.AppCompatDelegate diff --git a/app/src/main/java/be/scri/App.kt b/app/src/main/java/be/scri/App.kt index b1521b40..d2167dec 100644 --- a/app/src/main/java/be/scri/App.kt +++ b/app/src/main/java/be/scri/App.kt @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri import android.app.Application diff --git a/app/src/main/java/be/scri/activities/MainActivity.kt b/app/src/main/java/be/scri/activities/MainActivity.kt index 5df87617..4d81a71f 100644 --- a/app/src/main/java/be/scri/activities/MainActivity.kt +++ b/app/src/main/java/be/scri/activities/MainActivity.kt @@ -1,5 +1,5 @@ /** - * Implements the main activity with a custom action bar, ViewPager navigation, and dynamic UI adjustments based on user interactions. + * Implements the main activity with a custom action bar, ViewPager navigation, and dynamic UI adjustments. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.activities import android.content.Context diff --git a/app/src/main/java/be/scri/adapters/ViewPagerAdapter.kt b/app/src/main/java/be/scri/adapters/ViewPagerAdapter.kt index 4b20dfed..bd1764a9 100644 --- a/app/src/main/java/be/scri/adapters/ViewPagerAdapter.kt +++ b/app/src/main/java/be/scri/adapters/ViewPagerAdapter.kt @@ -1,5 +1,5 @@ /** - * Provides a ViewPager2 adapter for managing fragments in the main activity, including Main, Settings, and About fragments. + * An adapter for managing fragments in the main activity including Main (Installation), Settings, and About fragments. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.adapters import androidx.fragment.app.Fragment diff --git a/app/src/main/java/be/scri/extensions/CommonsContext.kt b/app/src/main/java/be/scri/extensions/CommonsContext.kt index ee20cca2..8a7957e5 100644 --- a/app/src/main/java/be/scri/extensions/CommonsContext.kt +++ b/app/src/main/java/be/scri/extensions/CommonsContext.kt @@ -1,5 +1,5 @@ /** - * Defines extension functions and properties for accessing shared preferences and BaseConfig in a Context. + * Functions and properties for accessing shared preferences and BaseConfig. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.extensions import android.content.Context diff --git a/app/src/main/java/be/scri/extensions/Context.kt b/app/src/main/java/be/scri/extensions/Context.kt index b0b9135f..629afc19 100644 --- a/app/src/main/java/be/scri/extensions/Context.kt +++ b/app/src/main/java/be/scri/extensions/Context.kt @@ -1,5 +1,5 @@ /** - * Provides extension properties and functions for retrieving configuration settings and calculating stroke color based on theme and background preferences. + * Functions for retrieving configuration settings and calculating color based on theme and background preferences. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.extensions import android.content.Context diff --git a/app/src/main/java/be/scri/extensions/ContextStyling.kt b/app/src/main/java/be/scri/extensions/ContextStyling.kt index 6b3bbd85..148ca31c 100644 --- a/app/src/main/java/be/scri/extensions/ContextStyling.kt +++ b/app/src/main/java/be/scri/extensions/ContextStyling.kt @@ -1,5 +1,5 @@ /** - * Provides extension functions for determining and retrieving proper text, key, background, and primary colors based on user configuration and system theme settings. + * Functions for determining and retrieving proper text and colors based on user settings. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.extensions import android.content.Context diff --git a/app/src/main/java/be/scri/extensions/Drawable.kt b/app/src/main/java/be/scri/extensions/Drawable.kt index d860f75a..41aa0c7e 100644 --- a/app/src/main/java/be/scri/extensions/Drawable.kt +++ b/app/src/main/java/be/scri/extensions/Drawable.kt @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.extensions import android.graphics.PorterDuff diff --git a/app/src/main/java/be/scri/extensions/Int.kt b/app/src/main/java/be/scri/extensions/Int.kt index 6d59cf22..7ad2d983 100644 --- a/app/src/main/java/be/scri/extensions/Int.kt +++ b/app/src/main/java/be/scri/extensions/Int.kt @@ -1,5 +1,5 @@ /** - * Provides extension functions for manipulating colors, including contrast adjustment, alpha adjustment, random value generation within a range, and darkening/lightening of colors. + * Functions for manipulating colors used within the application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.extensions import android.graphics.Color diff --git a/app/src/main/java/be/scri/extensions/RecyclerView.kt b/app/src/main/java/be/scri/extensions/RecyclerView.kt index 265a4e03..7cc8d57c 100644 --- a/app/src/main/java/be/scri/extensions/RecyclerView.kt +++ b/app/src/main/java/be/scri/extensions/RecyclerView.kt @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.extensions import CustomDividerItemDecoration diff --git a/app/src/main/java/be/scri/extensions/View.kt b/app/src/main/java/be/scri/extensions/View.kt index 519813b8..7f1a9188 100644 --- a/app/src/main/java/be/scri/extensions/View.kt +++ b/app/src/main/java/be/scri/extensions/View.kt @@ -1,5 +1,5 @@ /** - * This file contains utility functions for managing visibility and haptic feedback in Android views. + * Utility functions for managing visibility and haptic feedback in Android views. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.extensions import android.view.HapticFeedbackConstants diff --git a/app/src/main/java/be/scri/fragments/AboutFragment.kt b/app/src/main/java/be/scri/fragments/AboutFragment.kt index e3f1f365..921cbe8d 100644 --- a/app/src/main/java/be/scri/fragments/AboutFragment.kt +++ b/app/src/main/java/be/scri/fragments/AboutFragment.kt @@ -1,5 +1,5 @@ /** - * This file implements the AboutFragment, providing functionality for the About screen in the app, including theme settings, user interactions, and fragment navigation. + * Handles displaying the about page and related app content. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.fragments import android.os.Bundle diff --git a/app/src/main/java/be/scri/fragments/LanguageSettingsFragment.kt b/app/src/main/java/be/scri/fragments/LanguageSettingsFragment.kt index 15a96f4a..d5d8c8f0 100644 --- a/app/src/main/java/be/scri/fragments/LanguageSettingsFragment.kt +++ b/app/src/main/java/be/scri/fragments/LanguageSettingsFragment.kt @@ -1,5 +1,5 @@ /** - * This file implements the LanguageSettingsFragment, allowing users to change language preferences and navigate within the app's settings. + * Handles displaying the language settings for app language preferences. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.fragments import android.os.Bundle diff --git a/app/src/main/java/be/scri/fragments/MainFragment.kt b/app/src/main/java/be/scri/fragments/MainFragment.kt index e6902d27..d23d874f 100644 --- a/app/src/main/java/be/scri/fragments/MainFragment.kt +++ b/app/src/main/java/be/scri/fragments/MainFragment.kt @@ -1,5 +1,5 @@ /** - * This file implements the MainFragment, displaying the installation screen and handling dark mode preferences. + * Handles displaying the installation screen and related app content. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.fragments import android.content.Context diff --git a/app/src/main/java/be/scri/fragments/PrivacyPolicyFragment.kt b/app/src/main/java/be/scri/fragments/PrivacyPolicyFragment.kt index 838c6d73..686d1c59 100644 --- a/app/src/main/java/be/scri/fragments/PrivacyPolicyFragment.kt +++ b/app/src/main/java/be/scri/fragments/PrivacyPolicyFragment.kt @@ -1,5 +1,5 @@ /** - * This file implements the PrivacyPolicyFragment, displaying the privacy policy screen and managing navigation within the app's legal sections. + * Handles displaying information about the privacy policy. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.fragments import android.os.Bundle diff --git a/app/src/main/java/be/scri/fragments/ScribeFragment.kt b/app/src/main/java/be/scri/fragments/ScribeFragment.kt index d4e98dda..bbb7a900 100644 --- a/app/src/main/java/be/scri/fragments/ScribeFragment.kt +++ b/app/src/main/java/be/scri/fragments/ScribeFragment.kt @@ -1,5 +1,5 @@ /** - * This file implements the ScribeFragment, a base fragment class that includes functionality for hiding hints and loading other fragments with back-stack support. + * Handles displaying information like app hints and other fragments. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.fragments import android.util.Log diff --git a/app/src/main/java/be/scri/fragments/SettingsFragment.kt b/app/src/main/java/be/scri/fragments/SettingsFragment.kt index 569c165b..18481a3a 100644 --- a/app/src/main/java/be/scri/fragments/SettingsFragment.kt +++ b/app/src/main/java/be/scri/fragments/SettingsFragment.kt @@ -1,5 +1,5 @@ /** - * Manages user preferences like dark mode, language selection, and keyboard settings. + * Handles displaying user settings for the application and language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.fragments import SettingsScreen diff --git a/app/src/main/java/be/scri/fragments/ThirdPartyFragment.kt b/app/src/main/java/be/scri/fragments/ThirdPartyFragment.kt index b5087516..a3b51638 100644 --- a/app/src/main/java/be/scri/fragments/ThirdPartyFragment.kt +++ b/app/src/main/java/be/scri/fragments/ThirdPartyFragment.kt @@ -1,5 +1,5 @@ /** - * handles displaying third-party legal and privacy information, and manages back navigation and action bar visibility. + * Handles displaying information about third-party code, legal and the privacy policy. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.fragments import android.os.Bundle diff --git a/app/src/main/java/be/scri/fragments/WikimediaScribeFragment.kt b/app/src/main/java/be/scri/fragments/WikimediaScribeFragment.kt index daab31eb..365c1a9c 100644 --- a/app/src/main/java/be/scri/fragments/WikimediaScribeFragment.kt +++ b/app/src/main/java/be/scri/fragments/WikimediaScribeFragment.kt @@ -1,5 +1,5 @@ /** - * displays information about Wikimedia and Scribe, and manages back navigation and action bar visibility. + * Handles displaying information about Scribe's relationship with the Wikimedia movement. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.fragments import android.os.Bundle diff --git a/app/src/main/java/be/scri/helpers/AlphanumericComparator.kt b/app/src/main/java/be/scri/helpers/AlphanumericComparator.kt index c8b5c169..6ead0a53 100644 --- a/app/src/main/java/be/scri/helpers/AlphanumericComparator.kt +++ b/app/src/main/java/be/scri/helpers/AlphanumericComparator.kt @@ -1,5 +1,5 @@ /** - * contains the AlphanumericComparator class, which compares two strings in a way that sorts alphanumeric values correctly, such as making "IMG_5.jpg" come before "IMG_10.jpg". + * A test class to prepare for application testing. * * Copyright (C) 2024 Scribe * @@ -10,17 +10,18 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers // Taken from https://gist.github.com/MichaelRocks/1b94bb44c7804e999dbf31dac86955ec. // Make IMG_5.jpg come before IMG_10.jpg. -// This is a example test so suppressed as it doesn't effect the application +// This is a example test, so it is suppressed as it doesn't effect the application. @Suppress("NestedBlockDepth") class AlphanumericComparator { fun compare( diff --git a/app/src/main/java/be/scri/helpers/BaseConfig.kt b/app/src/main/java/be/scri/helpers/BaseConfig.kt index 61cba309..9124766a 100644 --- a/app/src/main/java/be/scri/helpers/BaseConfig.kt +++ b/app/src/main/java/be/scri/helpers/BaseConfig.kt @@ -1,5 +1,5 @@ /** - * A configuration helper class for managing app settings like colors, theme preferences, and language choices via SharedPreferences. + * A configuration helper class for managing app settings. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers import android.content.Context diff --git a/app/src/main/java/be/scri/helpers/CommonsConstants.kt b/app/src/main/java/be/scri/helpers/CommonsConstants.kt index 2319b005..76fd9512 100644 --- a/app/src/main/java/be/scri/helpers/CommonsConstants.kt +++ b/app/src/main/java/be/scri/helpers/CommonsConstants.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for CommonsConstants. + * Common constants that are used throughout helper classes and objects. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers val DARK_GREY = 0xFF333333.toInt() diff --git a/app/src/main/java/be/scri/helpers/Config.kt b/app/src/main/java/be/scri/helpers/Config.kt index f7773ee1..240ce543 100644 --- a/app/src/main/java/be/scri/helpers/Config.kt +++ b/app/src/main/java/be/scri/helpers/Config.kt @@ -1,5 +1,5 @@ /** - * A class that extends BaseConfig to manage additional app settings, such as keypress behavior, theme preferences, and double-tap actions. + * A class that extends BaseConfig to manage additional app settings. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers import android.content.Context diff --git a/app/src/main/java/be/scri/helpers/Constants.kt b/app/src/main/java/be/scri/helpers/Constants.kt index df763c5a..cc745e17 100644 --- a/app/src/main/java/be/scri/helpers/Constants.kt +++ b/app/src/main/java/be/scri/helpers/Constants.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for Constants. + * Constants that are used throughout helper classes and objects. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers const val SHIFT_OFF = 0 diff --git a/app/src/main/java/be/scri/helpers/CustomAdapter.kt b/app/src/main/java/be/scri/helpers/CustomAdapter.kt index 536e603c..eae0bdf8 100644 --- a/app/src/main/java/be/scri/helpers/CustomAdapter.kt +++ b/app/src/main/java/be/scri/helpers/CustomAdapter.kt @@ -1,5 +1,5 @@ /** - * A RecyclerView adapter that supports multiple view types (image, switch, and text) and handles dynamic actions based on item type in a list. + * A RecyclerView adapter that supports multiple view types. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers import android.content.Context diff --git a/app/src/main/java/be/scri/helpers/DatabaseHelper.kt b/app/src/main/java/be/scri/helpers/DatabaseHelper.kt index 0d6bc947..9b180cc6 100644 --- a/app/src/main/java/be/scri/helpers/DatabaseHelper.kt +++ b/app/src/main/java/be/scri/helpers/DatabaseHelper.kt @@ -1,5 +1,5 @@ /** - * Manages database functions. + * A helper to facilitate database calls for Scribe keyboard commands. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers import android.content.Context diff --git a/app/src/main/java/be/scri/helpers/HintUtils.kt b/app/src/main/java/be/scri/helpers/HintUtils.kt index 38f0dcfb..c3a5bf7b 100644 --- a/app/src/main/java/be/scri/helpers/HintUtils.kt +++ b/app/src/main/java/be/scri/helpers/HintUtils.kt @@ -1,5 +1,5 @@ /** - * A utility class for resetting user hint preferences in the app, clearing any previously shown hints in various sections.. + * A helper to facilitate resetting application hints if the user would like to see them again. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers import android.content.Context diff --git a/app/src/main/java/be/scri/helpers/MyKeyboard.kt b/app/src/main/java/be/scri/helpers/MyKeyboard.kt index b35c86a6..485bcd41 100644 --- a/app/src/main/java/be/scri/helpers/MyKeyboard.kt +++ b/app/src/main/java/be/scri/helpers/MyKeyboard.kt @@ -1,5 +1,5 @@ /** - * Custom keyboard implementation for handling keyboard layouts, rows, and keys with XML-based configuration. + * Custom keyboard implementation for handling keyboard layouts, rows and keys with XML-based configuration. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers import android.annotation.SuppressLint diff --git a/app/src/main/java/be/scri/helpers/PreferencesHelper.kt b/app/src/main/java/be/scri/helpers/PreferencesHelper.kt index e39c46aa..e00eb9ac 100644 --- a/app/src/main/java/be/scri/helpers/PreferencesHelper.kt +++ b/app/src/main/java/be/scri/helpers/PreferencesHelper.kt @@ -1,5 +1,5 @@ /** - * Utility class to manage app preferences, including settings for space bar double-tap, accent characters, emoji suggestions, keypress vibration, popups, and light/dark mode. + * A helper to facilitate setting preferences for individual language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers import android.app.UiModeManager diff --git a/app/src/main/java/be/scri/helpers/RatingHelper.kt b/app/src/main/java/be/scri/helpers/RatingHelper.kt index c6de650a..0351300b 100644 --- a/app/src/main/java/be/scri/helpers/RatingHelper.kt +++ b/app/src/main/java/be/scri/helpers/RatingHelper.kt @@ -1,5 +1,5 @@ /** - * Handles app rating functionality, detecting the installation source and launching the appropriate review flow on Google Play or F-Droid. + * A helper to facilitate rating the application on Google Play or F-Droid. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers import android.content.Context diff --git a/app/src/main/java/be/scri/helpers/ShareHelper.kt b/app/src/main/java/be/scri/helpers/ShareHelper.kt index ea82540a..ab635546 100644 --- a/app/src/main/java/be/scri/helpers/ShareHelper.kt +++ b/app/src/main/java/be/scri/helpers/ShareHelper.kt @@ -1,5 +1,5 @@ /** - * Facilitates sharing the app's GitHub link or sending an email to the Scribe team by launching appropriate intents. + * A helper to facilitate sharing of the application and contacting the team. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers import android.content.ActivityNotFoundException diff --git a/app/src/main/java/be/scri/helpers/english/ENInterfaceVariables.kt b/app/src/main/java/be/scri/helpers/english/ENInterfaceVariables.kt index 43fbb128..0e5301d4 100644 --- a/app/src/main/java/be/scri/helpers/english/ENInterfaceVariables.kt +++ b/app/src/main/java/be/scri/helpers/english/ENInterfaceVariables.kt @@ -1,5 +1,5 @@ /** - * contains the ENInterfaceVariables object, which holds constants and variables for English language interface elements. + * Interface variables for English language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers.english object ENInterfaceVariables { diff --git a/app/src/main/java/be/scri/helpers/french/FRInterfaceVariables.kt b/app/src/main/java/be/scri/helpers/french/FRInterfaceVariables.kt index accf6ada..b8b8f024 100644 --- a/app/src/main/java/be/scri/helpers/french/FRInterfaceVariables.kt +++ b/app/src/main/java/be/scri/helpers/french/FRInterfaceVariables.kt @@ -1,5 +1,5 @@ /** - * contains the ENInterfaceVariables object, which holds constants and variables for French language interface elements, + * Interface variables for French language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers.french object FRInterfaceVariables { diff --git a/app/src/main/java/be/scri/helpers/german/DEInterfaceVariables.kt b/app/src/main/java/be/scri/helpers/german/DEInterfaceVariables.kt index 07123576..1c12da66 100644 --- a/app/src/main/java/be/scri/helpers/german/DEInterfaceVariables.kt +++ b/app/src/main/java/be/scri/helpers/german/DEInterfaceVariables.kt @@ -1,5 +1,5 @@ /** - * contains the ENInterfaceVariables object, which holds constants and variables for German language interface elements, + * Interface variables for German language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers.german object DEInterfaceVariables { diff --git a/app/src/main/java/be/scri/helpers/italian/ITInterfaceVariables.kt b/app/src/main/java/be/scri/helpers/italian/ITInterfaceVariables.kt index 6054a8b4..82c3d2dc 100644 --- a/app/src/main/java/be/scri/helpers/italian/ITInterfaceVariables.kt +++ b/app/src/main/java/be/scri/helpers/italian/ITInterfaceVariables.kt @@ -1,5 +1,5 @@ /** - * contains the ENInterfaceVariables object, which holds constants and variables for Italian language interface elements,. + * Interface variables for Italian language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers.italian object ITInterfaceVariables { diff --git a/app/src/main/java/be/scri/helpers/portugese/PTInterfaceVariables.kt b/app/src/main/java/be/scri/helpers/portugese/PTInterfaceVariables.kt index 04aaaa9e..de406e11 100644 --- a/app/src/main/java/be/scri/helpers/portugese/PTInterfaceVariables.kt +++ b/app/src/main/java/be/scri/helpers/portugese/PTInterfaceVariables.kt @@ -1,5 +1,5 @@ /** - * contains the ENInterfaceVariables object, which holds constants and variables for Portugese language interface elements, + * Interface variables for Portuguese language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers.portugese object PTInterfaceVariables { diff --git a/app/src/main/java/be/scri/helpers/russian/RUInterfaceVariables.kt b/app/src/main/java/be/scri/helpers/russian/RUInterfaceVariables.kt index 9aeadd88..28cf6064 100644 --- a/app/src/main/java/be/scri/helpers/russian/RUInterfaceVariables.kt +++ b/app/src/main/java/be/scri/helpers/russian/RUInterfaceVariables.kt @@ -1,5 +1,5 @@ /** - * contains the ENInterfaceVariables object, which holds constants and variables for Russian language interface elements, + * Interface variables for Russian language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers.russian object RUInterfaceVariables { diff --git a/app/src/main/java/be/scri/helpers/spanish/ESInterfaceVariables.kt b/app/src/main/java/be/scri/helpers/spanish/ESInterfaceVariables.kt index 8b6c8d8b..f3603ec0 100644 --- a/app/src/main/java/be/scri/helpers/spanish/ESInterfaceVariables.kt +++ b/app/src/main/java/be/scri/helpers/spanish/ESInterfaceVariables.kt @@ -1,5 +1,5 @@ /** - * contains the ENInterfaceVariables object, which holds constants and variables for Spanish language interface elements, + * Interface variables for Spanish language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers.spanish object ESInterfaceVariables { diff --git a/app/src/main/java/be/scri/helpers/swedish/SVInterfaceVariables.kt b/app/src/main/java/be/scri/helpers/swedish/SVInterfaceVariables.kt index 736ffdea..f7a46ac1 100644 --- a/app/src/main/java/be/scri/helpers/swedish/SVInterfaceVariables.kt +++ b/app/src/main/java/be/scri/helpers/swedish/SVInterfaceVariables.kt @@ -1,5 +1,5 @@ /** - * contains the ENInterfaceVariables object, which holds constants and variables for Swedish language interface elements, + * Interface variables for Swedish language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.helpers.swedish object SVInterfaceVariables { diff --git a/app/src/main/java/be/scri/models/ItemsViewModel.kt b/app/src/main/java/be/scri/models/ItemsViewModel.kt index 53f3d981..5205f4c8 100644 --- a/app/src/main/java/be/scri/models/ItemsViewModel.kt +++ b/app/src/main/java/be/scri/models/ItemsViewModel.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for ItemsViewModel. + * The item view model class used in the application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.models import android.app.Activity diff --git a/app/src/main/java/be/scri/models/SwitchItem.kt b/app/src/main/java/be/scri/models/SwitchItem.kt index ffed2faa..d56a1675 100644 --- a/app/src/main/java/be/scri/models/SwitchItem.kt +++ b/app/src/main/java/be/scri/models/SwitchItem.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for SwitchItem. + * The switch item model class used in the application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.models sealed class Item diff --git a/app/src/main/java/be/scri/models/TextItem.kt b/app/src/main/java/be/scri/models/TextItem.kt index 5333684f..8ca69f81 100644 --- a/app/src/main/java/be/scri/models/TextItem.kt +++ b/app/src/main/java/be/scri/models/TextItem.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for TextItem. + * The text item model class used in the application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.models import androidx.fragment.app.Fragment diff --git a/app/src/main/java/be/scri/services/EnglishKeyboardIME.kt b/app/src/main/java/be/scri/services/EnglishKeyboardIME.kt index 038612bf..3bd62ab3 100644 --- a/app/src/main/java/be/scri/services/EnglishKeyboardIME.kt +++ b/app/src/main/java/be/scri/services/EnglishKeyboardIME.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for EnglishKeyboardIME. + * The input method (IME) for the English language keyboard. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.services import android.text.InputType diff --git a/app/src/main/java/be/scri/services/FrenchKeyboardIME.kt b/app/src/main/java/be/scri/services/FrenchKeyboardIME.kt index ce4b4679..eda27545 100644 --- a/app/src/main/java/be/scri/services/FrenchKeyboardIME.kt +++ b/app/src/main/java/be/scri/services/FrenchKeyboardIME.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for FrenchKeyboardIME. + * The input method (IME) for the French language keyboard. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.services import android.text.InputType diff --git a/app/src/main/java/be/scri/services/GermanKeyboardIME.kt b/app/src/main/java/be/scri/services/GermanKeyboardIME.kt index ea8dc7bd..0fb7bb02 100644 --- a/app/src/main/java/be/scri/services/GermanKeyboardIME.kt +++ b/app/src/main/java/be/scri/services/GermanKeyboardIME.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for GermanKeyboardIME. + * The input method (IME) for the German language keyboard. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.services import android.text.InputType diff --git a/app/src/main/java/be/scri/services/ItalianKeyboardIME.kt b/app/src/main/java/be/scri/services/ItalianKeyboardIME.kt index 255c119c..06b41138 100644 --- a/app/src/main/java/be/scri/services/ItalianKeyboardIME.kt +++ b/app/src/main/java/be/scri/services/ItalianKeyboardIME.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for ItalianKeyboardIME. + * The input method (IME) for the Italian language keyboard. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.services import android.text.InputType diff --git a/app/src/main/java/be/scri/services/PortugueseKeyboardIME.kt b/app/src/main/java/be/scri/services/PortugueseKeyboardIME.kt index 6d718174..828a4c8c 100644 --- a/app/src/main/java/be/scri/services/PortugueseKeyboardIME.kt +++ b/app/src/main/java/be/scri/services/PortugueseKeyboardIME.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for PortugueseKeyboardIME. + * The input method (IME) for the Portuguese language keyboard. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.services import android.text.InputType diff --git a/app/src/main/java/be/scri/services/RussianKeyboardIME.kt b/app/src/main/java/be/scri/services/RussianKeyboardIME.kt index 04d2877d..189345bd 100644 --- a/app/src/main/java/be/scri/services/RussianKeyboardIME.kt +++ b/app/src/main/java/be/scri/services/RussianKeyboardIME.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for RussianKeyboardIME. + * The input method (IME) for the Russian language keyboard. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.services import android.text.InputType diff --git a/app/src/main/java/be/scri/services/SimpleKeyboardIME.kt b/app/src/main/java/be/scri/services/SimpleKeyboardIME.kt index c5028d83..fe02900f 100644 --- a/app/src/main/java/be/scri/services/SimpleKeyboardIME.kt +++ b/app/src/main/java/be/scri/services/SimpleKeyboardIME.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for SimpleKeyboardIME. + * The base keyboard input method (IME) imported into all language keyboards. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.services import android.content.Context diff --git a/app/src/main/java/be/scri/services/SpanishKeyboardIME.kt b/app/src/main/java/be/scri/services/SpanishKeyboardIME.kt index 021bd689..72cefb87 100644 --- a/app/src/main/java/be/scri/services/SpanishKeyboardIME.kt +++ b/app/src/main/java/be/scri/services/SpanishKeyboardIME.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for SpanishKeyboardIME. + * The input method (IME) for the Spanish language keyboard. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.services import android.text.InputType diff --git a/app/src/main/java/be/scri/services/SwedishKeyboardIME.kt b/app/src/main/java/be/scri/services/SwedishKeyboardIME.kt index 4397e175..42d89c69 100644 --- a/app/src/main/java/be/scri/services/SwedishKeyboardIME.kt +++ b/app/src/main/java/be/scri/services/SwedishKeyboardIME.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for SwedishKeyboardIME. + * The input method (IME) for the Swedish language keyboard. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.services import android.text.InputType diff --git a/app/src/main/java/be/scri/ui/common/components/AboutPageItemComp.kt b/app/src/main/java/be/scri/ui/common/components/AboutPageItemComp.kt index 87a8fc41..3a1eff3d 100644 --- a/app/src/main/java/be/scri/ui/common/components/AboutPageItemComp.kt +++ b/app/src/main/java/be/scri/ui/common/components/AboutPageItemComp.kt @@ -1,5 +1,5 @@ /** - * A composable component that displays a row with a title, leading and trailing icons, and handles click events with customizable styling and layout. + * A composable component that displays a row with a title as well as leading and trailing icons. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.common.components import androidx.compose.foundation.clickable diff --git a/app/src/main/java/be/scri/ui/common/components/ClickableItemComp.kt b/app/src/main/java/be/scri/ui/common/components/ClickableItemComp.kt index a6f46fdc..90339620 100644 --- a/app/src/main/java/be/scri/ui/common/components/ClickableItemComp.kt +++ b/app/src/main/java/be/scri/ui/common/components/ClickableItemComp.kt @@ -1,5 +1,5 @@ /** - * A composable component that displays a clickable item with a title, optional description, and a right arrow icon, supporting custom layout and styling. + * A composable component that displays a clickable item with a title, optional description and an arrow icon. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.common.components import androidx.compose.foundation.clickable diff --git a/app/src/main/java/be/scri/ui/common/components/ComposeScaffoldContainer.kt b/app/src/main/java/be/scri/ui/common/components/ComposeScaffoldContainer.kt index 1c4bca97..2827b210 100644 --- a/app/src/main/java/be/scri/ui/common/components/ComposeScaffoldContainer.kt +++ b/app/src/main/java/be/scri/ui/common/components/ComposeScaffoldContainer.kt @@ -1,5 +1,5 @@ /** - * A composable function for a screen layout in the main activity, featuring a scrollable column with a title, a content area inside a card, and customizable bottom spacing. + * A composable function for a screen layout in the main activity. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.common.components import android.annotation.SuppressLint diff --git a/app/src/main/java/be/scri/ui/common/components/ItemCardContainer.kt b/app/src/main/java/be/scri/ui/common/components/ItemCardContainer.kt index 638d96c9..1b69edd7 100644 --- a/app/src/main/java/be/scri/ui/common/components/ItemCardContainer.kt +++ b/app/src/main/java/be/scri/ui/common/components/ItemCardContainer.kt @@ -1,5 +1,5 @@ /** - * A composable function that displays a list of items (clickable, switchable, or external link) inside a card container, with an optional divider between items. + * A composable function that displays a list of items inside a card container. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.common.components import androidx.compose.foundation.layout.Column diff --git a/app/src/main/java/be/scri/ui/common/components/ItemCardContainerWithTitle.kt b/app/src/main/java/be/scri/ui/common/components/ItemCardContainerWithTitle.kt index 567d6db4..7a01186e 100644 --- a/app/src/main/java/be/scri/ui/common/components/ItemCardContainerWithTitle.kt +++ b/app/src/main/java/be/scri/ui/common/components/ItemCardContainerWithTitle.kt @@ -1,5 +1,5 @@ /** - * A composable function that displays a title above a list of items inside a card container. It includes the ability to show optional dividers between items. + * A composable function that displays a title above a list of items inside a card container. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.common.components import androidx.compose.foundation.layout.Column diff --git a/app/src/main/java/be/scri/ui/common/components/SwitchableItemComp.kt b/app/src/main/java/be/scri/ui/common/components/SwitchableItemComp.kt index 35c6c4e5..1eb457af 100644 --- a/app/src/main/java/be/scri/ui/common/components/SwitchableItemComp.kt +++ b/app/src/main/java/be/scri/ui/common/components/SwitchableItemComp.kt @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.common.components import androidx.compose.foundation.background diff --git a/app/src/main/java/be/scri/ui/models/ScribeItem.kt b/app/src/main/java/be/scri/ui/models/ScribeItem.kt index 746580af..2570c232 100644 --- a/app/src/main/java/be/scri/ui/models/ScribeItem.kt +++ b/app/src/main/java/be/scri/ui/models/ScribeItem.kt @@ -1,6 +1,5 @@ /** - * Sealed class defining different types of items (clickable, switchable, external link, and custom) used in the app. - * + * A class defining different types of items used in the application interface. * * Copyright (C) 2024 Scribe * @@ -11,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.models import androidx.annotation.DrawableRes diff --git a/app/src/main/java/be/scri/ui/models/ScribeItemList.kt b/app/src/main/java/be/scri/ui/models/ScribeItemList.kt index 6102a668..7e44e5c9 100644 --- a/app/src/main/java/be/scri/ui/models/ScribeItemList.kt +++ b/app/src/main/java/be/scri/ui/models/ScribeItemList.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for ScribeItemList. + * A class defining lists of ScribeItem elements. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.models import androidx.compose.runtime.Immutable diff --git a/app/src/main/java/be/scri/ui/screens/AboutScreen.kt b/app/src/main/java/be/scri/ui/screens/AboutScreen.kt index 1af0dcd7..a992633f 100644 --- a/app/src/main/java/be/scri/ui/screens/AboutScreen.kt +++ b/app/src/main/java/be/scri/ui/screens/AboutScreen.kt @@ -1,5 +1,5 @@ /** - * Composable screen that displays information about the app, including community links, feedback, support options, and legal information. + * The about page of the application with links to the community as well as sub pages for detailed descriptions. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.screens import android.annotation.SuppressLint diff --git a/app/src/main/java/be/scri/ui/screens/InstallationScreen.kt b/app/src/main/java/be/scri/ui/screens/InstallationScreen.kt index da2c39ca..5b9e4f40 100644 --- a/app/src/main/java/be/scri/ui/screens/InstallationScreen.kt +++ b/app/src/main/java/be/scri/ui/screens/InstallationScreen.kt @@ -1,5 +1,5 @@ /** - * Composable screen that guides users through the installation process of the Scribe keyboard, including settings and download options. + * The installation page of the application with details for installing Scribe keyboards and downloading data. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.screens import android.content.Intent diff --git a/app/src/main/java/be/scri/ui/screens/LanguageSettingsScreen.kt b/app/src/main/java/be/scri/ui/screens/LanguageSettingsScreen.kt index a19efc1e..2f34b0c9 100644 --- a/app/src/main/java/be/scri/ui/screens/LanguageSettingsScreen.kt +++ b/app/src/main/java/be/scri/ui/screens/LanguageSettingsScreen.kt @@ -1,5 +1,5 @@ /** - * Composable UI screen that allows users to customize language-specific keyboard settings, including toggles for period on double-tap, emoji suggestions, and accent character handling. + * The settings sub menu page for languages that allows for customization of language keyboard interfaces. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.screens import android.annotation.SuppressLint diff --git a/app/src/main/java/be/scri/ui/screens/PrivacyPolicyScreen.kt b/app/src/main/java/be/scri/ui/screens/PrivacyPolicyScreen.kt index ebef3573..a4f3ad95 100644 --- a/app/src/main/java/be/scri/ui/screens/PrivacyPolicyScreen.kt +++ b/app/src/main/java/be/scri/ui/screens/PrivacyPolicyScreen.kt @@ -1,5 +1,5 @@ /** - * Composable UI screen that displays the privacy policy of the app. It uses the MainActivityComposeScreen component to structure the screen and shows the privacy policy text with appropriate styling and padding. + * The about screen that displays the privacy policy for the application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.screens import androidx.compose.foundation.layout.padding diff --git a/app/src/main/java/be/scri/ui/screens/SettingsScreen.kt b/app/src/main/java/be/scri/ui/screens/SettingsScreen.kt index 5ab5885d..b67a4370 100644 --- a/app/src/main/java/be/scri/ui/screens/SettingsScreen.kt +++ b/app/src/main/java/be/scri/ui/screens/SettingsScreen.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for SettingsScreen. + * The settings tab for the application including settings for language keyboards as sub menus. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + import android.content.Context import android.os.Bundle import android.view.inputmethod.InputMethodManager diff --git a/app/src/main/java/be/scri/ui/screens/ThirdPartyScreen.kt b/app/src/main/java/be/scri/ui/screens/ThirdPartyScreen.kt index dce92074..d566b8db 100644 --- a/app/src/main/java/be/scri/ui/screens/ThirdPartyScreen.kt +++ b/app/src/main/java/be/scri/ui/screens/ThirdPartyScreen.kt @@ -1,5 +1,5 @@ /** - * displays third-party legal information and acknowledgements used in the app, including a specific entry for "Simple Keyboard." + * The about screen to display third-party legal information for software used in the application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.screens import androidx.compose.foundation.layout.Column diff --git a/app/src/main/java/be/scri/ui/screens/WikimediaScreen.kt b/app/src/main/java/be/scri/ui/screens/WikimediaScreen.kt index db067620..3a9efa14 100644 --- a/app/src/main/java/be/scri/ui/screens/WikimediaScreen.kt +++ b/app/src/main/java/be/scri/ui/screens/WikimediaScreen.kt @@ -1,5 +1,5 @@ /** - * showcases the relationship between Scribe and Wikimedia, displaying logos and text related to Wikidata and Wikipedia. + * The about screen for describing the relationship between Scribe and the Wikimedia movement. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.screens import androidx.compose.foundation.Image diff --git a/app/src/main/java/be/scri/ui/theme/Colors.kt b/app/src/main/java/be/scri/ui/theme/Colors.kt index de86bea3..f5620d9f 100644 --- a/app/src/main/java/be/scri/ui/theme/Colors.kt +++ b/app/src/main/java/be/scri/ui/theme/Colors.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for Colors. + * Custom colors for use throughout the application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.theme import androidx.compose.ui.graphics.Color diff --git a/app/src/main/java/be/scri/ui/theme/ScribeTheme.kt b/app/src/main/java/be/scri/ui/theme/ScribeTheme.kt index 6d1a2a33..a86ecb46 100644 --- a/app/src/main/java/be/scri/ui/theme/ScribeTheme.kt +++ b/app/src/main/java/be/scri/ui/theme/ScribeTheme.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for ScribeTheme. + * Light and dark mode themes for the application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.theme import androidx.compose.material3.MaterialTheme diff --git a/app/src/main/java/be/scri/ui/theme/Typography.kt b/app/src/main/java/be/scri/ui/theme/Typography.kt index d33e12fa..73130af0 100644 --- a/app/src/main/java/be/scri/ui/theme/Typography.kt +++ b/app/src/main/java/be/scri/ui/theme/Typography.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for Typography. + * Text styles for the application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.ui.theme import androidx.compose.material3.Typography diff --git a/app/src/main/java/be/scri/views/CustomDividerItemDecoration.kt b/app/src/main/java/be/scri/views/CustomDividerItemDecoration.kt index b4ad9059..2edf4c68 100644 --- a/app/src/main/java/be/scri/views/CustomDividerItemDecoration.kt +++ b/app/src/main/java/be/scri/views/CustomDividerItemDecoration.kt @@ -1,5 +1,5 @@ /** - * The **CustomDividerItemDecoration** class provides a custom divider to be added between items in a RecyclerView. It draws a drawable between each item, adjusting its position and size based on margins and item width. + * A custom divider for use in recycle views. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + import android.graphics.Canvas import android.graphics.Rect import android.graphics.drawable.Drawable diff --git a/app/src/main/java/be/scri/views/MyKeyboardView.kt b/app/src/main/java/be/scri/views/MyKeyboardView.kt index aba788d8..63836b73 100644 --- a/app/src/main/java/be/scri/views/MyKeyboardView.kt +++ b/app/src/main/java/be/scri/views/MyKeyboardView.kt @@ -1,5 +1,5 @@ /** - * custom keyboard view for an Android application, providing features such as key press handling, key layout management, and keyboard actions. It supports various input behaviors, including key presses, shift states, and custom feedback mechanisms. + * The base keyboard view for Scribe language keyboards application. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package be.scri.views import android.annotation.SuppressLint diff --git a/app/src/test/kotlin/fragments/MainFragmentTest.kt b/app/src/test/kotlin/fragments/MainFragmentTest.kt index 494fb525..e5070f2c 100644 --- a/app/src/test/kotlin/fragments/MainFragmentTest.kt +++ b/app/src/test/kotlin/fragments/MainFragmentTest.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for MainFragmentTest. + * Testing for MainFragment. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + import android.app.UiModeManager import android.content.Context import android.content.SharedPreferences diff --git a/app/src/test/kotlin/helpers/AlphanumericComparatorTest.kt b/app/src/test/kotlin/helpers/AlphanumericComparatorTest.kt index 898d497a..c414ce21 100644 --- a/app/src/test/kotlin/helpers/AlphanumericComparatorTest.kt +++ b/app/src/test/kotlin/helpers/AlphanumericComparatorTest.kt @@ -1,5 +1,5 @@ /** - * This file contains the implementation for AlphanumericComparatorTest. + * Testing for AlphanumericComparator. * * Copyright (C) 2024 Scribe * @@ -10,12 +10,13 @@ * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ + package helpers import be.scri.helpers.AlphanumericComparator diff --git a/license_template.txt b/license_template.txt deleted file mode 100644 index d30e3404..00000000 --- a/license_template.txt +++ /dev/null @@ -1,18 +0,0 @@ -/** - * {Description} - * - * Copyright (C) 2024 Scribe - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */