添加generateOverviewTree任务生成包目录

a8779687 · p x · 3c0a9549 · a8779687 · a8779687 · a8779687
Commit a8779687 authored Jan 05, 2026 by p x
--- a/app/src/main/java/com/sd/demo/ui/TDriveRouteActivity.kt
+++ b/app/src/main/java/com/sd/demo/ui/TDriveRouteActivity.kt
@@ -11,8 +11,8 @@ import com.minedata.minenavi.navi.NaviProgressData
 import com.minedata.minenavi.navi.SmoothNaviData
 import com.minedata.minenavi.navi.TmcSections
 import com.minedata.minenavi.util.Tools
-import com.cusc.map.bean.DriverRouteBean
-import com.cusc.map.bean.WayPoi
+import com.cusc.map.map2d.cdata.DriverRouteBean
+import com.cusc.map.map2d.cdata.WayPoi
 import com.cusc.map.map2d.inters.OnNaviPresenterListener
 import com.cusc.map.map2d.Navigate
 import com.cusc.map.map2d.PathPlanning

--- a/mapapi/build.gradle.kts
+++ b/mapapi/build.gradle.kts
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
+
 plugins {
    alias(libs.plugins.android.library)
    alias(libs.plugins.kotlin.android)
@@ -98,25 +100,25 @@ dependencies {


 dokka {
-
    dokkaPublications.javadoc {
-        moduleName.set(project.name)
-        moduleVersion.set(project.version.toString())
+        moduleName.set("mapsdk")
+//        moduleVersion.set(project.version.toString())
+        description="Android 地图SDK"
        // Standard output directory for HTML documentation
 //        outputDirectory.set(layout.buildDirectory.dir("dokka/html"))
        failOnWarning.set(false)
        suppressInheritedMembers.set(false)
        suppressObviousFunctions.set(true)
        offlineMode.set(true)
+
        dokkaSourceSets {
            configureEach {
                includes.from("package-info.md")
-//                suppressEmptyPackages.set(false)
                skipEmptyPackages.set(false)
                skipDeprecated.set(false)
                suppressGeneratedFiles.set(true)
-//                jdkVersion.set(17)
-//                documentedVisibilities.set(setOf(VisibilityModifier.Public)) // OR documentedVisibilities(VisibilityModifier.Public)
+                jdkVersion.set(17)
+                documentedVisibilities.set(setOf(VisibilityModifier.Public)) // OR documentedVisibilities(VisibilityModifier.Public)
                perPackageOption {
                    matchingRegex.set(".*map2d\\.amap|.*map2d\\.mine")
                    suppress.set(true)//suppress = true：完全禁用匹配包的文档生成
@@ -145,6 +147,88 @@ dokka {
 }


+// 在 build.gradle.kts 中添加
+tasks.register("generateOverviewTree") {
+    group = "documentation"
+    description = "Generate overview-tree.html for Javadoc"
+
+    doLast {
+        val outputDir = file("${layout.buildDirectory.get()}/dokka/javadoc")
+        outputDir.mkdirs()
+
+        val treeFile = outputDir.resolve("overview-tree.html")
+
+        // 读取现有的包信息
+        val packages = mutableListOf<Pair<String, String>>().apply {
+            add("com.cusc.map.location" to "定位包，提供定位功能")
+            add("com.cusc.map.map2d" to "二维地图包，提供栅格地图显示、覆盖物绘制等功能")
+            add("com.cusc.map.map2d.cdata" to "二维地图包数据业务实体")
+            add("com.cusc.map.map2d.inters" to "二维地图接口包")
+            add("com.cusc.map.map3d" to "三维地图包，基于3dtitle的地图绘制")
+            add("com.cusc.map.parkroad" to "车道局部地图包")
+            add("com.cusc.map.scenario" to "业务相关包，提供车辆、感知物、预警管理")
+            add("com.cusc.map.scenario.bean" to "业务数据实体类")
+            add("com.cusc.map.ui" to "界面相关包，包含地图底图")
+        }
+
+        // 构建包层次结构
+        val packageTree = mutableMapOf<String, MutableList<Pair<String, String>>>()
+
+        packages.forEach { (pkg, desc) ->
+            val parts = pkg.split(".")
+            if (parts.size > 3) { // 假设 com.cusc.map 是根包
+                val parent = parts.take(3).joinToString(".")
+                val child = pkg
+                packageTree.getOrPut(parent) { mutableListOf() }.add(child to desc)
+            }
+        }
+
+        // 生成HTML内容
+        val htmlContent = """
+        <!DOCTYPE HTML>
+        <html lang="zh">
+        <head>
+           <title>mapapi 1.0.0</title>
+            <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+            <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+            <link rel="stylesheet" type="text/css" href="dokka-javadoc-stylesheet.css" title="Style">
+            <style>
+                .tree ul { padding-left: 20px; list-style-type: none; }
+                .tree li { margin: 5px 0; }
+                .package-link { color: #0066CC; }
+            </style>
+        </head>
+        <body>
+
+        <div class="contentContainer">
+            <div class="block">
+      
+                <ul class="tree">
+                    <li>
+                        <strong>com.cusc.map</strong>
+                        <ul>
+                            ${packages.joinToString("") { (pkg, desc) ->
+            val pkgPath = pkg.replace(".", "/")
+            """
+                                <li>
+                                    <a href="$pkgPath/package-summary.html" class="package-link">$pkg</a>
+                                    <span style="color: #666; font-size: 12px;">$desc</span>
+                                </li>
+                                """
+        }}
+                        </ul>
+                    </li>
+                </ul>
+            </div>
+        </div>
+        </body>
+        </html>
+        """.trimIndent()
+
+        treeFile.writeText(htmlContent)
+        println("Generated overview-tree.html at: ${treeFile.absolutePath}")
+    }
+}

 //group = "msmap"
 //version = "1.0"

--- a/mapapi/package-info.md
+++ b/mapapi/package-info.md
 # Package com.cusc.map.map2d
 二维地图包，提供栅格地图显示、覆盖物绘制等功能。

+# Package com.cusc.map.map2d.cdata
+二维地图包数据业务实体
+
+# Package com.cusc.map.map2d.inters
+二维地图接口包
+
 # Package com.cusc.map.location
 定位包，提供定位功能

@@ -14,5 +20,8 @@
 # Package com.cusc.map.scenario
 业务相关包，提供车辆、感知物、预警管理

+# Package com.cusc.map.scenario.bean
+业务数据实体类
+
 # Package com.cusc.map.ui
 界面相关包，包含地图底图
\ No newline at end of file
--- a/mapapi/src/main/java/com/cusc/map/map2d/DrawInMap.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/DrawInMap.kt
@@ -7,7 +7,7 @@ import com.cusc.map.map2d.cdata.MarkerM
 import com.cusc.map.map2d.cdata.MapOverlay
 import com.cusc.map.map2d.mine.MineDrawInMap

-/***绘制线选项**/
+/**绘制线选项**/
 class MsPolylineOptions {
    /***填充颜色**/
    var fcolor = "#000000".toColorInt()
@@ -23,7 +23,7 @@ class MsPolylineOptions {
 }


-/***绘制圆形选项**/
+/**绘制圆形选项**/
 class CircleOptionsM {
    /**半径（米）**/
    var radius = 100f
@@ -38,7 +38,7 @@ class CircleOptionsM {
    var strokeWidth = 15f
 }

-/***绘制一个面选项**/
+/**绘制一个面选项**/
 class MsPolygonOptions {
    /***填充颜色**/
    var fillColor = "#10FF00FF".toColorInt()

--- a/mapapi/src/main/java/com/cusc/map/map2d/MsOperationParent.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/MsOperationParent.kt
@@ -4,7 +4,7 @@ import com.cusc.map.ui.MapReadyView
 import com.cusc.map.utils.ToastHelper

 //地图操作父类
-open class MsOperationParent {
+internal open class MsOperationParent {
    fun getMapReadView(): MapReadyView? {
        if (UserCtx.instance.mContext == null) {
            return null

--- a/mapapi/src/main/java/com/cusc/map/map2d/Navigate.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/Navigate.kt
 package com.cusc.map.map2d

-import com.cusc.map.bean.DriverRouteBean
-import com.cusc.map.bean.WayPoi
 import com.cusc.map.map2d.inters.OnNaviPresenterListener
 import com.cusc.map.map2d.amap.AmapNai
+import com.cusc.map.map2d.cdata.DriverRouteBean
 import com.cusc.map.map2d.cdata.LatLngM
+import com.cusc.map.map2d.cdata.WayPoi
 import com.cusc.map.map2d.mine.MineNai
 import com.cusc.map.ui.MapReadyView


--- a/mapapi/src/main/java/com/cusc/map/map2d/PathPlanning.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/PathPlanning.kt
 package com.cusc.map.map2d

-import com.cusc.map.bean.WayPoi
 import com.cusc.map.map2d.amap.AmapRoutePlans
 import com.cusc.map.map2d.cdata.LatLngM
+import com.cusc.map.map2d.cdata.WayPoi
 import com.cusc.map.map2d.inters.OnDriveRoute
 import com.cusc.map.map2d.mine.MineRoutePlans


--- a/mapapi/src/main/java/com/cusc/map/map2d/WayPoi.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/WayPoi.kt
+package com.cusc.map.map2d
+
+/**途经点名坐标*/
+/**经点名字*/
\ No newline at end of file
--- a/mapapi/src/main/java/com/cusc/map/map2d/amap/AmapNai.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/amap/AmapNai.kt
@@ -7,7 +7,7 @@ import com.amap.api.navi.AmapNaviParams
 import com.amap.api.navi.AmapNaviType
 import com.amap.api.navi.AmapPageType
 import com.cusc.map.map2d.UserCtx
-import com.cusc.map.bean.WayPoi
+import com.cusc.map.map2d.cdata.WayPoi
 import com.cusc.map.map2d.cdata.LatLngM

 /**

--- a/mapapi/src/main/java/com/cusc/map/map2d/amap/AmapRoutePlans.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/amap/AmapRoutePlans.kt
@@ -9,8 +9,8 @@ import com.amap.api.navi.model.AMapNaviPath
 import com.amap.api.navi.model.NaviLatLng
 import com.amap.api.navi.view.RouteOverLay
 import com.cusc.map.map2d.UserCtx
-import com.cusc.map.bean.DriverRouteBean
-import com.cusc.map.bean.WayPoi
+import com.cusc.map.map2d.cdata.DriverRouteBean
+import com.cusc.map.map2d.cdata.WayPoi
 import com.cusc.map.map2d.inters.MyAMapNaviListener
 import com.cusc.map.map2d.cdata.LatLngM
 import com.cusc.map.map2d.inters.OnDriveRoute

--- a/mapapi/src/main/java/com/cusc/map/bean/DriverRouteBean.kt
+++ b/mapapi/src/main/java/com/cusc/map/bean/DriverRouteBean.kt
-package com.cusc.map.bean
+package com.cusc.map.map2d.cdata

 import com.amap.api.navi.model.AMapCalcRouteResult
 import com.minedata.minenavi.map.Route

--- a/mapapi/src/main/java/com/cusc/map/bean/WayPoi.kt
+++ b/mapapi/src/main/java/com/cusc/map/bean/WayPoi.kt
-package com.cusc.map.bean
+package com.cusc.map.map2d.cdata

 import android.os.Parcelable
-import com.cusc.map.map2d.cdata.LatLngM
 import kotlinx.parcelize.Parcelize

 /**途经点Poi***/
@@ -12,14 +11,5 @@ data class WayPoi(
    /**经点名字*/
    var passName: String
 ) : Parcelable
-/*
-{
-    */
-/**途经点名坐标*//*
-
-    var passPoint: MSLatLng? = null
-    */
-/**经点名字*//*
-
-    var passName = ""
-}*/
+/**途经点名坐标*/
+/**经点名字*/
\ No newline at end of file
--- a/mapapi/src/main/java/com/cusc/map/map2d/inters/OnDriveRoute.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/inters/OnDriveRoute.kt
 package com.cusc.map.map2d.inters

-import com.cusc.map.bean.DriverRouteBean
+import com.cusc.map.map2d.cdata.DriverRouteBean

 /**驾车路线返回*/
 interface OnDriveRoute {

--- a/mapapi/src/main/java/com/cusc/map/map2d/mine/MineNai.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/mine/MineNai.kt
@@ -20,7 +20,7 @@ import com.minedata.minenavi.navi.TmcSections
 import com.minedata.minenavi.tts.NaviSpeaker
 import com.minedata.minenavi.util.Tools
 import com.cusc.map.map2d.UserCtx
-import com.cusc.map.bean.WayPoi
+import com.cusc.map.map2d.cdata.WayPoi
 import com.cusc.map.map2d.inters.MyMineNaviListener
 import com.cusc.map.map2d.inters.OnNaviPresenterListener
 import com.cusc.map.map2d.cdata.LatLngM

--- a/mapapi/src/main/java/com/cusc/map/map2d/mine/MineNaiParams.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/mine/MineNaiParams.kt
 package com.cusc.map.map2d.mine

 import android.os.Parcelable
-import com.cusc.map.bean.WayPoi
+import com.cusc.map.map2d.cdata.WayPoi
 import com.cusc.map.map2d.cdata.LatLngM
 import kotlinx.parcelize.Parcelize


--- a/mapapi/src/main/java/com/cusc/map/map2d/mine/MineRoutePlans.kt
+++ b/mapapi/src/main/java/com/cusc/map/map2d/mine/MineRoutePlans.kt
@@ -13,8 +13,8 @@ import com.minedata.minenavi.navi.RouteCollection
 import com.minedata.minenavi.navi.RoutePlan
 import com.minedata.minenavi.navi.RouterErrorInfo
 import com.minedata.minenavi.util.Tools
-import com.cusc.map.bean.DriverRouteBean
-import com.cusc.map.bean.WayPoi
+import com.cusc.map.map2d.cdata.DriverRouteBean
+import com.cusc.map.map2d.cdata.WayPoi
 import com.cusc.map.map2d.inters.MyMineNaviListener
 import com.cusc.map.map2d.cdata.LatLngM
 import com.cusc.map.map2d.inters.OnDriveRoute

--- a/mapapi/src/main/java/com/cusc/map/map3d/AlertPath.kt
+++ b/mapapi/src/main/java/com/cusc/map/map3d/AlertPath.kt
 package com.cusc.map.map3d

 /**
- * Alert path
+ * 预警对象
 */
 data class AlertPath(
+    /**点集合**/
    val lines: List<AlertLine>,
    val alertType: Int
 )

- class AlertLine {
-     //    val evel: Int,
-     var lat: Double=0.0
-     var lon: Double=0.0
- }
\ No newline at end of file
+/**
+ * 预警点
+ */
+class AlertLine {
+    //    val evel: Int,
+    var lat: Double = 0.0
+    var lon: Double = 0.0
+}
\ No newline at end of file
--- a/mapapi/src/main/java/com/cusc/map/map3d/LockStatu.kt
+++ b/mapapi/src/main/java/com/cusc/map/map3d/LockStatu.kt
 package com.cusc.map.map3d

+/**车位锁状态*/
 class LockStatu {
    /**车位编号*/
    var code = ""

--- a/mapapi/src/main/java/com/cusc/map/map3d/ParkStatu.kt
+++ b/mapapi/src/main/java/com/cusc/map/map3d/ParkStatu.kt
 package com.cusc.map.map3d

-//停车位绘制  - 上面有其他车的状态（传入车辆占用情况绘制）
+/**停车位绘制  - 上面有其他车的状态（传入车辆占用情况绘制）*/
 data class ParkStatu(
    /**停车状态数组**/
    var spinfo: List<Spinfo>
 )

+/**传入车辆占用情况绘制*/
 class Spinfo {
    /**车位编号**/
    var code = ""

--- a/mapapi/src/main/java/com/cusc/map/map3d/PtcData.kt
+++ b/mapapi/src/main/java/com/cusc/map/map3d/PtcData.kt
@@ -2,7 +2,7 @@ package com.cusc.map.map3d


 /**
- * 感知物请求数据
+ * 三维地推感知物请求数据
 */
 class PtcData {
    companion object{
@@ -11,6 +11,9 @@ class PtcData {
    var ptcList: List<UnityPtc>?=null
 }

+/**
+ * 三维感知物数据
+ */
 class UnityPtc {
    /**感知物类型 1=车 2=人*/
    var pType = 1
@@ -28,6 +31,9 @@ class UnityPtc {
    var ptcid = ""
 }

+/**
+ * 三维感知物报警数据
+ */
 class WarnPtc {
    /**闪烁时长*/
    var aniTime = 0L