type: Update comments and add type reference links for better navigation. #387 #386

jaywcjlove · jaywcjlove · commit b6b8da2d9095 · 2025-05-22T18:40:59.000+08:00
diff --git a/packages/bezier-curve/src/index.tsx b/packages/bezier-curve/src/index.tsx
@@ -5,7 +5,7 @@ import { useBezierCurve } from './useBezierCurve';
 export * from './useBezierCurve';
 
 export interface BezierCurveProps extends OverlayProps, AMap.BezierCurveEvents, AMap.BezierCurveOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/circle-marker/src/index.tsx b/packages/circle-marker/src/index.tsx
@@ -5,7 +5,7 @@ import { useCircleMarker } from './useCircleMarker';
 export * from './useCircleMarker';
 
 export interface CircleMarkerProps extends OverlayProps, AMap.CircleMarkerEvents, AMap.CircleMarkerOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/circle/src/index.tsx b/packages/circle/src/index.tsx
@@ -5,7 +5,7 @@ import { useCircle } from './useCircle';
 export * from './useCircle';
 
 export interface CircleProps extends OverlayProps, AMap.CircleEvents, AMap.CircleOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/control-bar-control/src/index.tsx b/packages/control-bar-control/src/index.tsx
@@ -5,7 +5,7 @@ import { useControlBarControl } from './useControlBarControl';
 export * from './useControlBarControl';
 
 export interface ControlBarControlProps extends OverlayProps, AMap.ControlBarOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/ellipse/src/index.tsx b/packages/ellipse/src/index.tsx
@@ -5,7 +5,7 @@ import { useEllipse } from './useEllipse';
 export * from './useEllipse';
 
 export interface EllipseProps extends OverlayProps, AMap.EllipseEvents, AMap.EllipseOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/hawk-eye-control/src/index.tsx b/packages/hawk-eye-control/src/index.tsx
@@ -5,7 +5,7 @@ import { useHawkEyeControl } from './useHawkEyeControl';
 export * from './useHawkEyeControl';
 
 export interface HawkEyeControlProps extends OverlayProps, AMap.HawkEyeOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/info-window/src/index.tsx b/packages/info-window/src/index.tsx
@@ -5,7 +5,7 @@ import { useInfoWindow } from './useInfoWindow';
 
 export * from './useInfoWindow';
 export interface InfoWindowProps extends OverlayProps, AMap.InforWindowEvents, AMap.InforWindowOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/label-marker/src/index.tsx b/packages/label-marker/src/index.tsx
@@ -4,7 +4,7 @@ import { OverlayProps } from '@uiw/react-amap-map';
 import { useLabelMarker } from './useLabelMarker';
 
 export interface LabelMarkerProps extends OverlayProps, AMap.LabelMarkerEvents, AMap.LabelMarkerOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/map-type-control/src/index.tsx b/packages/map-type-control/src/index.tsx
@@ -5,7 +5,7 @@ import { useMapTypeControl } from './useMapTypeControl';
 
 export * from './useMapTypeControl';
 export interface MapTypeControlProps extends OverlayProps, AMap.MapTypeOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/marker/src/index.tsx b/packages/marker/src/index.tsx
@@ -7,7 +7,7 @@ import { useMarker } from './useMarker';
 export * from './useMarker';
 
 export interface MarkerProps extends OverlayProps, AMap.MarkerEvents, AMap.MarkerOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/mass-marks/src/index.tsx b/packages/mass-marks/src/index.tsx
@@ -6,7 +6,7 @@ import { useMassMarks } from './useMassMarks';
 export * from './useMassMarks';
 
 export interface MassMarksProps extends OverlayProps, AMap.MassMarksEvents, AMap.MassMarkersOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/polygon/src/index.tsx b/packages/polygon/src/index.tsx
@@ -8,7 +8,7 @@ export * from './usePolygon';
 export const PolygonContext = createContext<AMap.Polygon | undefined>(undefined);
 
 export interface PolygonProps extends OverlayProps, AMap.PolygonEvents, AMap.PolygonOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/polyline/src/index.tsx b/packages/polyline/src/index.tsx
@@ -8,7 +8,7 @@ export * from './usePolyline';
 export const PolylineContext = createContext<AMap.Polyline | undefined>(undefined);
 
 export interface PolylineProps extends OverlayProps, AMap.PolylineEvents, AMap.PolylineOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/rectangle/src/index.tsx b/packages/rectangle/src/index.tsx
@@ -6,7 +6,7 @@ import { useRectangle } from './useRectangle';
 export * from './useRectangle';
 
 export interface RectangleProps extends OverlayProps, AMap.RectangleEvents, AMap.RectangleOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/scale-control/src/index.tsx b/packages/scale-control/src/index.tsx
@@ -6,7 +6,7 @@ import { useScaleControl } from './useScaleControl';
 export * from './useScaleControl';
 
 export interface ScaleControlProps extends OverlayProps, AMap.ScaleOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/text/src/index.tsx b/packages/text/src/index.tsx
@@ -6,7 +6,7 @@ import { useText } from './useText';
 export * from './useText';
 
 export interface TextProps extends OverlayProps, AMap.TextEvents, AMap.TextOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/tile-layer/src/index.tsx b/packages/tile-layer/src/index.tsx
@@ -12,7 +12,7 @@ export enum TileLayerType {
 }
 
 export interface TileLayerProps extends OverlayProps, AMap.TileLayerOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/tool-bar-control/src/index.tsx b/packages/tool-bar-control/src/index.tsx
@@ -6,7 +6,7 @@ import { useToolBarControl } from './useToolBarControl';
 export * from './useToolBarControl';
 
 export interface ToolBarControlProps extends OverlayProps, AMap.ToolBarOptions {
-  /** @deprecated use `visible` */
+  /** @deprecated use {@link visible} */
   visiable?: boolean;
   /** 覆盖物是否可见 */
   visible?: boolean;
diff --git a/packages/types/src/control.d.ts b/packages/types/src/control.d.ts
@@ -88,8 +88,12 @@ declare namespace AMap {
     (status: string, result: ReGeocoderResult): void
   }
   /**
-   * 地理编码
-   * https://lbs.amap.com/api/webservice/guide/api/georegeo#geo
+   * @deprecated 请使用 {@link ReverseGeocodeResult} 代替。
+   *
+   * 此接口为高德地理编码结果的封装版本，已不再与高德官方文档完全一致。
+   * 推荐迁移至 {@link ReverseGeocodeResult}，以获得更准确和持续维护的类型定义。
+   *
+   * 官方文档参考：https://lbs.amap.com/api/webservice/guide/api/georegeo#geo
    */
   interface ReGeocoderResult {
     info: string
@@ -109,9 +113,13 @@ declare namespace AMap {
       level: string
     }
   }
-
   /**
-   * 高德封装后的地理编码
+   * 高德地理编码结果（封装版本）。
+   *
+   * 此类型为对高德返回数据的二次封装，可能与官方文档略有差异。
+   *
+   * - 官方文档（仅供参考）：https://lbs.amap.com/api/webservice/guide/api/georegeo#geo
+   * - 背景说明与社区讨论：https://github.com/uiwjs/react-amap/issues/386
    */
   interface ReverseGeocodeResult {
     info: string
