Merge branch 'main' of github-personal:yml-org/YGraphs into feature/OS-56

Author: dkk009

YChartsLib/build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     id("com.android.library")
     id("org.jetbrains.kotlin.android")
+    id("org.jetbrains.dokka")
 }
 
 android {

YChartsLib/src/main/java/co/yml/charts/axis/XAxis.kt

@@ -161,6 +161,11 @@ private fun DrawScope.drawXAxisLabel(
     calculatedXAxisHeight
 }
 
+/**
+ * Returns triple of Xmax, Xmin & scale for given list of points and steps
+ * @param points: List of points in axis
+ * @param steps: Total steps in axis
+ */
 fun getXAxisScale(
     points: List<Point>,
     steps: Int,

YChartsLib/src/main/java/co/yml/charts/axis/YAxis.kt

@@ -179,7 +179,7 @@ private fun DrawScope.drawAxisLabel(
 
 @Preview(showBackground = true)
 @Composable
-fun YAxisPreview() {
+private fun YAxisPreview() {
     val yAxisData = AxisData.Builder()
         .steps(5)
         .bottomPadding(10.dp)

YChartsLib/src/main/java/co/yml/charts/chartcontainer/container/ScrollableCanvasContainer.kt

@@ -34,9 +34,11 @@ import co.yml.charts.chartcontainer.gestures.detectZoomGesture
  * @param onDraw: Draw any canvas inside the onDraw scope using the input params in the lambda fxn
  * @param drawXAndYAxis: Draw the X and Y axis along with the drawing area.
  * @param containerBackgroundColor: Background color of the whole container.
+ * @param isPinchZoomEnabled: True if user can zoom in and out else false
  * @param layoutDirection: Used to define the direction of scroll.
  * @param onPointClicked: Callback for tap detected along with offset for tap.
  * @param onScroll: Callback when user starts scrolling the graph.
+ * @param onZoomInAndOut: Callback when user starts zoomIn and Out w.r.t to the graph
  */
 
 @Composable
@@ -105,6 +107,11 @@ fun ScrollableCanvasContainer(
     }
 }
 
+/**
+ * Returns the scroll state within the start and computed max scrollOffset & filters invalid scroll states.
+ * @param currentScrollOffset: Current scroll offset when user trying to scroll the canvas.
+ * @param computedMaxScrollOffset: Maximum calculated scroll offset for given data set.
+ */
 fun checkAndGetMaxScrollOffset(currentScrollOffset: Float, computedMaxScrollOffset: Float): Float {
     return when {
         currentScrollOffset < 0f -> 0f

YChartsLib/src/main/java/co/yml/charts/chartcontainer/gestures/GestureExtensions.kt

@@ -8,6 +8,11 @@ import androidx.compose.ui.input.pointer.PointerInputScope
 import androidx.compose.ui.input.pointer.positionChanged
 import kotlin.math.abs
 
+/**
+ * Gesture support to detect and filter pointer scopes to give a zoom start callback
+ * @param isZoomAllowed: True if user is allowed to zoom.
+ * @param onZoom: Callback when zoom gesture is detected.
+ */
 internal suspend fun PointerInputScope.detectZoomGesture(
     isZoomAllowed: Boolean = true,
     onZoom: (zoom: Float) -> Unit

YChartsLib/src/main/java/co/yml/charts/common/components/ItemDivider.kt

@@ -9,6 +9,11 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.unit.Dp
 
+/**
+ * Draws a horizontal line as a divider for given thickness and color
+ * @param thickness: Defines the thickness of the divider.
+ * @param dividerColor: Defines the color of the divider.
+ */
 @Composable
 fun ItemDivider(thickness: Dp, dividerColor: Color = Color.Black) {
     Box(

YChartsLib/src/main/java/co/yml/charts/common/components/Legends.kt

@@ -14,6 +14,11 @@ import androidx.compose.ui.unit.dp
 import co.yml.charts.common.model.LegendLabel
 import co.yml.charts.common.model.LegendsConfig
 
+/**
+ * Renders the list of legends in a grid format for given given grid column count
+ * @param modifier: Defines the arrangements of ui compositions.
+ * @param legendsConfig: Defines the configurations required for rendering legends in [LegendsConfig]
+ */
 @Composable
 fun Legends(modifier: Modifier = Modifier, legendsConfig: LegendsConfig) {
     with(legendsConfig) {

YChartsLib/src/main/java/co/yml/charts/common/components/accessibility/AccessibilityBottomSheetDailog.kt

@@ -13,6 +13,9 @@ import androidx.compose.ui.semantics.semantics
 import androidx.compose.ui.unit.dp
 import kotlinx.coroutines.launch
 
+/**
+ * Bottom sheet to show items in vertical list view with a close button at top
+ */
 @ExperimentalMaterialApi
 @Composable
 fun AccessibilityBottomSheetDialog(

YChartsLib/src/main/java/co/yml/charts/common/components/accessibility/BarInfo.kt

@@ -12,6 +12,11 @@ import androidx.compose.ui.semantics.semantics
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
 
+/**
+ * Composable to display each bar item for given bar chart
+ * @param axisLabelDescription: Axis label description
+ * @param barDescription: Bar description
+ */
 @Composable
 fun BarInfo(
     axisLabelDescription: String,

YChartsLib/src/main/java/co/yml/charts/common/components/accessibility/CombinedChartInfo.kt

@@ -17,6 +17,15 @@ import co.yml.charts.ui.barchart.models.GroupBar
 import co.yml.charts.common.components.ItemDivider
 import co.yml.charts.common.model.Point
 
+/**
+ * Composable to display each combined chart item for given combined chart.
+ * @param pointsList: List of points in each item.
+ * @param lineColor: List of colors of lines as per line chart.
+ * @param groupBar: Details of each group bar.
+ * @param axisLabelDescription: Axis label description.
+ * @param barColorPaletteList: List of each bar colors for a given group bar.
+ * @param dividerColor: Divider color between each point items.
+ */
 @Composable
 fun CombinedChartInfo(
     pointsList: List<Point>,