Added comments

app/src/main/java/ir/apptune/calendar/MainActivity.kt

@@ -4,6 +4,9 @@ import android.os.Bundle
 import androidx.appcompat.app.AppCompatActivity
 import dagger.hilt.android.AndroidEntryPoint
 
+/**
+ * The single activity of the application
+ */
 @AndroidEntryPoint
 class MainActivity : AppCompatActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {

app/src/main/java/ir/apptune/calendar/ResourceUtils.kt

@@ -20,6 +20,9 @@ private const val VACATION = "IsVacation"
 private const val X_CALENDAR = "XCalendar"
 private const val IS_VACATION = "1"
 
+/**
+ * This class reads xml files that contain holidays dates
+ */
 class ResourceUtils(c: Context) {
 
     private fun getHashMapResource(c: Context, hashMapResId: Int) {

app/src/main/java/ir/apptune/calendar/base/BaseApplication.kt

@@ -3,5 +3,8 @@ package ir.apptune.calendar.base
 import android.app.Application
 import dagger.hilt.android.HiltAndroidApp
 
+/**
+ * Application class
+ */
 @HiltAndroidApp
 class BaseApplication : Application()

app/src/main/java/ir/apptune/calendar/di/HiltModules.kt

@@ -12,10 +12,16 @@ import ir.apptune.calendar.utils.CalendarTool
 import java.util.*
 import javax.inject.Singleton
 
+/**
+ * This object contains hilt modules needed for injection
+ */
 @Module
 @InstallIn(SingletonComponent::class)
 object DateModule {
 
+    /**
+     * Provides current date details
+     */
     @Provides
     @Singleton
     fun todayProvider(calendar: GregorianCalendar): CalendarModel {
@@ -25,14 +31,23 @@ object DateModule {
         }
     }
 
+    /**
+     * Provides Gregorian calendar instance
+     */
     @Provides
     @Singleton
     fun gregorianCalendarProvider() = GregorianCalendar()
 
+    /**
+     * Provides CalendarTool instance to convert dates from Gregorian to Shamsi
+     */
     @Provides
     @Singleton
     fun calendarToolProvider(calendar: GregorianCalendar) = CalendarTool(calendar)
 
+    /**
+     * Provides local repository
+     */
     @Provides
     @Singleton
     fun monthGeneratorProvider(app: Application, calendarModel: CalendarModel, calendarTool: CalendarTool): MonthGeneratorClass {

app/src/main/java/ir/apptune/calendar/features/calendar/details/DateDetailsDialogFragment.kt

@@ -24,7 +24,7 @@ import ir.apptune.calendar.utils.extensions.toPersianWeekDay
 import java.util.*
 
 /**
- * The activity that Pops-Up when user clicks on days, in MainPage calendar.
+ * Show details about the selected date in a popup form
  */
 @AndroidEntryPoint
 class DateDetailsDialogFragment : DialogFragment() {

app/src/main/java/ir/apptune/calendar/features/calendar/details/DateDetailsViewModel.kt

@@ -8,11 +8,18 @@ import ir.apptune.calendar.ResourceUtils
 import ir.apptune.calendar.pojo.CalendarModel
 import javax.inject.Inject
 
+/**
+ * ViewModel Of DateDetailsDialogFragment
+ */
 @HiltViewModel
 class DateDetailsViewModel @Inject constructor() : ViewModel() {
 
     private val eventsLiveData = MutableLiveData<String>()
 
+    /**
+     * Checks if there are any events on the selected date
+     * @param date the selected date
+     */
     fun getEvents(date: CalendarModel) {
         val persianTemp = date.iranianMonth * 100 + date.iranianDay
         val gregorianTemp = date.gMonth * 100 + date.gDay
@@ -24,5 +31,8 @@ class DateDetailsViewModel @Inject constructor() : ViewModel() {
         }
     }
 
+    /**
+     * Returns live data of [eventsLiveData]
+     */
     fun getEventsLiveData(): LiveData<String> = eventsLiveData
 }

app/src/main/java/ir/apptune/calendar/features/calendar/main/CalendarAdapter.kt

@@ -15,6 +15,9 @@ import ir.apptune.calendar.pojo.CalendarModel
 import ir.apptune.calendar.utils.EMPTY_DATE
 import ir.apptune.calendar.utils.extensions.toPersianNumber
 
+/**
+ * Adapter to show the calendar days
+ */
 class CalendarAdapter(val clickListener: (CalendarModel) -> Unit) : ListAdapter<CalendarModel, CalendarViewHolder>(CalendarDiffUtils()) {
 
     override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): CalendarViewHolder {
@@ -28,6 +31,9 @@ class CalendarAdapter(val clickListener: (CalendarModel) -> Unit) : ListAdapter<
     inner class CalendarViewHolder(private val binding: CalendarItemBinding, containerView: View) :
             RecyclerView.ViewHolder(containerView) {
 
+        /**
+         * Binds views via ViewBinding
+         */
         fun onBind(dateModel: CalendarModel) {
             with(dateModel) {
                 with(binding) {

app/src/main/java/ir/apptune/calendar/features/calendar/main/CalendarFragment.kt

@@ -17,6 +17,9 @@ import ir.apptune.calendar.utils.extensions.toPersianNumber
 import ir.apptune.calendar.utils.extensions.toPersianWeekDay
 import javax.inject.Inject
 
+/**
+ * Main view of the application that contains the calendar
+ */
 @AndroidEntryPoint
 class CalendarFragment : Fragment() {
 

app/src/main/java/ir/apptune/calendar/features/calendar/main/CalendarViewModel.kt

@@ -10,6 +10,9 @@ import ir.apptune.calendar.pojo.MonthType.PREVIOUS_MONTH
 import ir.apptune.calendar.repository.local.MonthGeneratorClass
 import javax.inject.Inject
 
+/**
+ * ViewModel of CalendarFragment
+ */
 @HiltViewModel
 class CalendarViewModel @Inject constructor(private val monthGenerator: MonthGeneratorClass) : ViewModel() {
 
@@ -20,13 +23,22 @@ class CalendarViewModel @Inject constructor(private val monthGenerator: MonthGen
         monthLiveData.value = monthGenerator.getMonthList(NEXT_MONTH)
     }
 
+    /**
+     * Fetches and publishes the next month (from the month that currently user is watching) as a list of days
+     */
     fun getNextMonth() {
         monthLiveData.value = monthGenerator.getMonthList(NEXT_MONTH)
     }
 
+    /**
+     * Fetches and publishes the previous month (from the month that currently user is watching) as a list of days
+     */
     fun getPreviousMonth() {
         monthLiveData.value = monthGenerator.getMonthList(PREVIOUS_MONTH)
     }
 
+    /**
+     * Returns live data of [monthLiveData]
+     */
     fun getMonthLiveData(): LiveData<List<CalendarModel>> = monthLiveData
 }

app/src/main/java/ir/apptune/calendar/pojo/DateModel.kt

@@ -1,3 +1,6 @@
 package ir.apptune.calendar.pojo
 
+/**
+ * Contains details of a day
+ */
 data class DateModel(val year: Int, val month: Int, val dayNumber: Int)

app/src/main/java/ir/apptune/calendar/pojo/MonthType.kt

@@ -1,3 +1,6 @@
 package ir.apptune.calendar.pojo
 
+/**
+ * An Enum to request next or previous month
+ */
 enum class MonthType { NEXT_MONTH, PREVIOUS_MONTH }

app/src/main/java/ir/apptune/calendar/utils/CalendarTool.kt

@@ -507,4 +507,4 @@ class CalendarTool {
             = 0
     private var march // The march day of Farvardin the first (First day of jaYear)
             = 0
-} // End of Class 'JavaSource_Calendar
+}