add comments for UndocumentedPublicFunction

bytebeats · bytebeats · commit 2393a80d8ba7 · 2024-05-29T16:02:57.000+08:00
diff --git a/charts/src/main/java/me/bytebeats/views/charts/AxisLine.kt b/charts/src/main/java/me/bytebeats/views/charts/AxisLine.kt
@@ -23,6 +23,7 @@ data class AxisLine(
         }
     }
 
+    @Suppress("UndocumentedPublicFunction")
     fun paint(density: Density) {
         mPaint.strokeWidth = thickness.value * density.density
     }
diff --git a/charts/src/main/java/me/bytebeats/views/charts/Colors.kt b/charts/src/main/java/me/bytebeats/views/charts/Colors.kt
@@ -1,6 +1,8 @@
 package me.bytebeats.views.charts
 
 import androidx.compose.ui.graphics.Color
+import me.bytebeats.views.charts.util.FLOAT_0_5
+import me.bytebeats.views.charts.util.FLOAT_255
 
 /**
  * Created by bytebeats on 2021/9/24 : 10:51
@@ -10,9 +12,9 @@ import androidx.compose.ui.graphics.Color
 
 fun Color.toLegacyInt(): Int {
     return android.graphics.Color.argb(
-        (alpha * 255F + .5F).toInt(),
-        (red * 255F + .5F).toInt(),
-        (green * 255F + .5F).toInt(),
-        (blue * 255F + .5F).toInt()
+        (alpha * FLOAT_255 + FLOAT_0_5).toInt(),
+        (red * FLOAT_255 + FLOAT_0_5).toInt(),
+        (green * FLOAT_255 + FLOAT_0_5).toInt(),
+        (blue * FLOAT_255 + FLOAT_0_5).toInt()
     )
-}
+}
diff --git a/charts/src/main/java/me/bytebeats/views/charts/bar/render/bar/IBarDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/bar/render/bar/IBarDrawer.kt
@@ -11,6 +11,15 @@ import me.bytebeats.views.charts.bar.BarChartData
  * Quote: Peasant. Educated. Worker
  */
 interface IBarDrawer {
+
+    /**
+     * Draw bar
+     *
+     * @param drawScope the scope to draw
+     * @param canvas the Canvas to draw on
+     * @param barArea the bar area to draw
+     * @param bar the bar data
+     */
     fun drawBar(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/bar/render/label/ILabelDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/bar/render/label/ILabelDrawer.kt
@@ -10,8 +10,34 @@ import androidx.compose.ui.graphics.drawscope.DrawScope
  * Quote: Peasant. Educated. Worker
  */
 interface ILabelDrawer {
+
+
+    /**
+     * Required x axis height
+     *
+     * @param drawScope the scope to draw in
+     * @return required height
+     */
     fun requiredXAxisHeight(drawScope: DrawScope): Float = 0F
+
+
+    /**
+     * Required above bar height
+     *
+     * @param drawScope the scope to draw in
+     * @return required height
+     */
     fun requiredAboveBarHeight(drawScope: DrawScope): Float = 0F
+
+    /**
+     * Draw label
+     *
+     * @param drawScope the scope to draw in
+     * @param canvas the canvas to draw on
+     * @param label the label to draw on the axis
+     * @param barArea the area to draw a bar
+     * @param xAxisArea the x axis area to draw
+     */
     fun drawLabel(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/bar/render/xaxis/IXAxisDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/bar/render/xaxis/IXAxisDrawer.kt
@@ -10,7 +10,22 @@ import androidx.compose.ui.graphics.drawscope.DrawScope
  * Quote: Peasant. Educated. Worker
  */
 interface IXAxisDrawer {
+
+    /**
+     * Required height
+     *
+     * @param drawScope the draw scope to require height
+     * @return required height
+     */
     fun requiredHeight(drawScope: DrawScope): Float
+
+    /**
+     * Draw x axis line
+     *
+     * @param drawScope the scope to draw
+     * @param canvas the canvas to draw on
+     * @param drawableArea the area to draw a drawable
+     */
     fun drawXAxisLine(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/bar/render/yaxis/IYAxisDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/bar/render/yaxis/IYAxisDrawer.kt
@@ -10,12 +10,30 @@ import androidx.compose.ui.graphics.drawscope.DrawScope
  * Quote: Peasant. Educated. Worker
  */
 interface IYAxisDrawer {
+
+    /**
+     * Draw axis line
+     *
+     * @param drawScope the scope to draw
+     * @param canvas the canvas to draw on
+     * @param drawableArea the area to draw a drawable
+     */
     fun drawAxisLine(
         drawScope: DrawScope,
         canvas: Canvas,
         drawableArea: Rect
     )
 
+
+    /**
+     * Draw axis labels
+     *
+     * @param drawScope the scope to draw
+     * @param canvas the canvas to draw on
+     * @param drawableArea the drawable area
+     * @param minValue the min value of the y axis data
+     * @param maxValue the max value of the y axis data
+     */
     fun drawAxisLabels(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/line/LineCharts.kt b/charts/src/main/java/me/bytebeats/views/charts/line/LineCharts.kt
@@ -15,7 +15,7 @@ import me.bytebeats.views.charts.util.FLOAT_100
  * Quote: Peasant. Educated. Worker
  */
 
-fun computeDrawableArea(
+internal fun computeDrawableArea(
     xAxisDrawableArea: Rect,
     yAxisDrawableArea: Rect,
     size: Size,
@@ -30,7 +30,7 @@ fun computeDrawableArea(
     )
 }
 
-fun computeXAxisDrawableArea(
+internal fun computeXAxisDrawableArea(
     yAxisWidth: Float,
     labelHeight: Float,
     size: Size
@@ -44,7 +44,7 @@ fun computeXAxisDrawableArea(
     )
 }
 
-fun computeXAxisLabelsDrawableArea(
+internal fun computeXAxisLabelsDrawableArea(
     xAxisDrawableArea: Rect,
     offset: Float
 ): Rect {
@@ -57,7 +57,7 @@ fun computeXAxisLabelsDrawableArea(
     )
 }
 
-fun Density.computeYAxisDrawableArea(
+internal fun Density.computeYAxisDrawableArea(
     xAxisLabelSize: Float,
     size: Size
 ): Rect {
@@ -71,7 +71,7 @@ fun Density.computeYAxisDrawableArea(
     )
 }
 
-fun computePointLocation(
+internal fun computePointLocation(
     drawableArea: Rect,
     lineChartData: LineChartData,
     point: LineChartData.Point,
@@ -85,7 +85,7 @@ fun computePointLocation(
     )
 }
 
-fun withProgress(
+internal fun withProgress(
     index: Int,
     lineChartData: LineChartData,
     transitionProgress: Float,
@@ -103,7 +103,7 @@ fun withProgress(
     }
 }
 
-fun computeLinePath(
+internal fun computeLinePath(
     drawableArea: Rect,
     lineChartData: LineChartData,
     transitionProgress: Float
@@ -130,7 +130,7 @@ fun computeLinePath(
     }
 }
 
-fun computeFillPath(
+internal fun computeFillPath(
     drawableArea: Rect,
     lineChartData: LineChartData,
     transitionProgress: Float
diff --git a/charts/src/main/java/me/bytebeats/views/charts/line/render/line/ILineDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/line/render/line/ILineDrawer.kt
@@ -10,6 +10,14 @@ import androidx.compose.ui.graphics.drawscope.DrawScope
  * Quote: Peasant. Educated. Worker
  */
 interface ILineDrawer {
+
+    /**
+     * Draw line
+     *
+     * @param drawScope the scope to draw in
+     * @param canvas the canvas to draw on
+     * @param linePath the line path to draw
+     */
     fun drawLine(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/line/render/line/ILineShader.kt b/charts/src/main/java/me/bytebeats/views/charts/line/render/line/ILineShader.kt
@@ -10,6 +10,14 @@ import androidx.compose.ui.graphics.drawscope.DrawScope
  * Quote: Peasant. Educated. Worker
  */
 interface ILineShader {
+
+    /**
+     * fill slice
+     *
+     * @param drawScope the scope to draw in
+     * @param canvas the canvas to draw on
+     * @param fillPath the path to fill
+     */
     fun fillLine(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/line/render/point/IPointDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/line/render/point/IPointDrawer.kt
@@ -10,6 +10,14 @@ import androidx.compose.ui.graphics.drawscope.DrawScope
  * Quote: Peasant. Educated. Worker
  */
 interface IPointDrawer {
+
+    /**
+     * Draw point
+     *
+     * @param drawScope the scope to draw in
+     * @param canvas the canvas to draw on
+     * @param center the center point to draw a point
+     */
     fun drawPoint(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/line/render/xaxis/IXAxisDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/line/render/xaxis/IXAxisDrawer.kt
@@ -10,14 +10,35 @@ import androidx.compose.ui.graphics.drawscope.DrawScope
  * Quote: Peasant. Educated. Worker
  */
 interface IXAxisDrawer {
+
+    /**
+     * require height
+     *
+     * @param drawScope the scope to draw in
+     */
     fun requireHeight(drawScope: DrawScope): Float
 
+    /**
+     * Draw x axis line
+     *
+     * @param drawScope the scope to draw in
+     * @param canvas the canvas to draw on
+     * @param drawableArea the area to draw a drawable
+     */
     fun drawXAxisLine(
         drawScope: DrawScope,
         canvas: Canvas,
         drawableArea: Rect
     )
 
+    /**
+     * Draw labels in x axis
+     *
+     * @param drawScope the scope to draw in
+     * @param canvas the canvas to draw on
+     * @param drawableArea the area to draw
+     * @param labels the labels to draw on axis
+     */
     fun drawXAxisLabels(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/line/render/yaxis/IYAxisDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/line/render/yaxis/IYAxisDrawer.kt
@@ -10,12 +10,29 @@ import androidx.compose.ui.graphics.drawscope.DrawScope
  * Quote: Peasant. Educated. Worker
  */
 interface IYAxisDrawer {
+
+    /**
+     * Draw axis line
+     *
+     * @param drawScope the scope to draw in
+     * @param canvas the canvas to draw on
+     * @param drawableArea the area to draw a drawable
+     */
     fun drawAxisLine(
         drawScope: DrawScope,
         canvas: Canvas,
         drawableArea: Rect
     )
 
+    /**
+     * Draw axis labels
+     *
+     * @param drawScope the scope to draw in
+     * @param canvas the canvas to draw on
+     * @param drawableArea the area to draw
+     * @param minValue the min value of the y axis data
+     * @param maxValue the max value of the y axis data
+     */
     fun drawAxisLabels(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/pie/PieChartData.kt b/charts/src/main/java/me/bytebeats/views/charts/pie/PieChartData.kt
@@ -14,5 +14,8 @@ data class PieChartData(val slices: List<Slice>) {
             return slices.map { it.value }.sum()
         }
 
-    data class Slice(val value: Float, val color: Color)
+    data class Slice(
+        val value: Float,
+        val color: Color
+    )
 }
diff --git a/charts/src/main/java/me/bytebeats/views/charts/pie/render/ISliceDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/pie/render/ISliceDrawer.kt
@@ -11,6 +11,17 @@ import me.bytebeats.views.charts.pie.PieChartData
  * Quote: Peasant. Educated. Worker
  */
 interface ISliceDrawer {
+
+
+    /**
+     * Draw slice
+     * @param drawScope the scope to draw in
+     * @param canvas the canvas to draw on
+     * @param area the area to draw
+     * @param startAngle the start angle to draw a slice
+     * @param sweepAngle the sweep angle to draw a slice
+     * @param slice the slice data to draw
+     */
     fun drawSlice(
         drawScope: DrawScope,
         canvas: Canvas,
diff --git a/charts/src/main/java/me/bytebeats/views/charts/pie/render/SimpleSliceDrawer.kt b/charts/src/main/java/me/bytebeats/views/charts/pie/render/SimpleSliceDrawer.kt
@@ -7,6 +7,7 @@ import androidx.compose.ui.graphics.Paint
 import androidx.compose.ui.graphics.PaintingStyle
 import androidx.compose.ui.graphics.drawscope.DrawScope
 import me.bytebeats.views.charts.pie.PieChartData
+import me.bytebeats.views.charts.util.FLOAT_200
 
 /**
  * Created by bytebeats on 2021/9/24 : 14:36
@@ -30,7 +31,7 @@ class SimpleSliceDrawer(private val sliceThickness: Float = 25F) : ISliceDrawer
 
     private fun computeSectorThickness(area: Size): Float {
         val minSize = area.width.coerceAtMost(area.height)
-        return sliceThickness * minSize / 200F
+        return sliceThickness * minSize / FLOAT_200
     }
 
     private fun computeDrawableArea(area: Size): Rect {
@@ -65,4 +66,4 @@ class SimpleSliceDrawer(private val sliceThickness: Float = 25F) : ISliceDrawer
             useCenter = false,
         )
     }
-}
+}
diff --git a/charts/src/main/java/me/bytebeats/views/charts/util/Floats.kt b/charts/src/main/java/me/bytebeats/views/charts/util/Floats.kt
@@ -2,5 +2,8 @@ package me.bytebeats.views.charts.util
 
 internal const val FLOAT_10 = 10F
 internal const val FLOAT_100 = 100F
+internal const val FLOAT_200 = 200F
+internal const val FLOAT_255 = 255F
 internal const val FLOAT_360 = 360F
 internal const val FLOAT_1_5 = 1.5F
+internal const val FLOAT_0_5 = .5F
diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ data class AxisLine(`
`23`	`23`	`}`
`24`	`24`	`}`
`25`	`25`
	`26`	`+ @Suppress("UndocumentedPublicFunction")`
`26`	`27`	`fun paint(density: Density) {`
`27`	`28`	`mPaint.strokeWidth = thickness.value * density.density`
`28`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ import me.bytebeats.views.charts.util.FLOAT_100`
`15`	`15`	`* Quote: Peasant. Educated. Worker`
`16`	`16`	`*/`
`17`	`17`
`18`		`-fun computeDrawableArea(`
	`18`	`+internal fun computeDrawableArea(`
`19`	`19`	`xAxisDrawableArea: Rect,`
`20`	`20`	`yAxisDrawableArea: Rect,`
`21`	`21`	`size: Size,`
`@@ -30,7 +30,7 @@ fun computeDrawableArea(`
`30`	`30`	`)`
`31`	`31`	`}`
`32`	`32`
`33`		`-fun computeXAxisDrawableArea(`
	`33`	`+internal fun computeXAxisDrawableArea(`
`34`	`34`	`yAxisWidth: Float,`
`35`	`35`	`labelHeight: Float,`
`36`	`36`	`size: Size`
`@@ -44,7 +44,7 @@ fun computeXAxisDrawableArea(`
`44`	`44`	`)`
`45`	`45`	`}`
`46`	`46`
`47`		`-fun computeXAxisLabelsDrawableArea(`
	`47`	`+internal fun computeXAxisLabelsDrawableArea(`
`48`	`48`	`xAxisDrawableArea: Rect,`
`49`	`49`	`offset: Float`
`50`	`50`	`): Rect {`
`@@ -57,7 +57,7 @@ fun computeXAxisLabelsDrawableArea(`
`57`	`57`	`)`
`58`	`58`	`}`
`59`	`59`
`60`		`-fun Density.computeYAxisDrawableArea(`
	`60`	`+internal fun Density.computeYAxisDrawableArea(`
`61`	`61`	`xAxisLabelSize: Float,`
`62`	`62`	`size: Size`
`63`	`63`	`): Rect {`
`@@ -71,7 +71,7 @@ fun Density.computeYAxisDrawableArea(`
`71`	`71`	`)`
`72`	`72`	`}`
`73`	`73`
`74`		`-fun computePointLocation(`
	`74`	`+internal fun computePointLocation(`
`75`	`75`	`drawableArea: Rect,`
`76`	`76`	`lineChartData: LineChartData,`
`77`	`77`	`point: LineChartData.Point,`
`@@ -85,7 +85,7 @@ fun computePointLocation(`
`85`	`85`	`)`
`86`	`86`	`}`
`87`	`87`
`88`		`-fun withProgress(`
	`88`	`+internal fun withProgress(`
`89`	`89`	`index: Int,`
`90`	`90`	`lineChartData: LineChartData,`
`91`	`91`	`transitionProgress: Float,`
`@@ -103,7 +103,7 @@ fun withProgress(`
`103`	`103`	`}`
`104`	`104`	`}`
`105`	`105`
`106`		`-fun computeLinePath(`
	`106`	`+internal fun computeLinePath(`
`107`	`107`	`drawableArea: Rect,`
`108`	`108`	`lineChartData: LineChartData,`
`109`	`109`	`transitionProgress: Float`
`@@ -130,7 +130,7 @@ fun computeLinePath(`
`130`	`130`	`}`
`131`	`131`	`}`
`132`	`132`
`133`		`-fun computeFillPath(`
	`133`	`+internal fun computeFillPath(`
`134`	`134`	`drawableArea: Rect,`
`135`	`135`	`lineChartData: LineChartData,`
`136`	`136`	`transitionProgress: Float`