fix service doc return 重复漏写 review by luox

SuperMap · Sep 12, 2023 · 58c5d24 · 58c5d24
1 parent efd4552
commit 58c5d24
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 8 deletions.
diff --git a/src/common/iServer/DatasourceService.js b/src/common/iServer/DatasourceService.js
@@ -43,6 +43,9 @@ export class DatasourceService extends CommonServiceBase {
     /**
      * @function DatasourceService.prototype.getDatasourceService
      * @description 获取指定数据源信息。
+     * @param {string} datasourceName - 数据源名称。
+     * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
+     * @returns {Promise} Promise 对象。
      */
     getDatasourceService(datasourceName, callback) {
         let url = Util.urlPathAppend(this.url,`datasources/name/${datasourceName}`);
@@ -52,6 +55,8 @@ export class DatasourceService extends CommonServiceBase {
     /**
      * @function DatasourceService.prototype.getDatasourcesService
      * @description 获取所有数据源信息。
+     * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
+     * @returns {Promise} Promise 对象。
      */
     getDatasourcesService(callback) {
         let url = Util.urlPathAppend(this.url,`datasources`);
@@ -60,6 +65,9 @@ export class DatasourceService extends CommonServiceBase {
     /**
      * @function DatasourceService.prototype.setDatasourceService
      * @description 更新数据源信息。
+     * @param {Object} params 请求参数信息。
+     * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
+     * @returns {Promise} Promise 对象。
      */
     setDatasourceService(params, callback) {
         if (!params) {

diff --git a/src/leaflet/services/ProcessingService.js b/src/leaflet/services/ProcessingService.js
@@ -77,7 +77,6 @@ export var ProcessingService = ServiceBase.extend({
      * @description 获取密度分析的状态。
      * @param {string} id - 密度分析 ID。
      * @returns {Object} 密度分析的状态。
-     * @returns {Promise} Promise 对象。
      */
     getKernelDensityJobState: function(id) {
       return this._processingService.getKernelDensityJobState(id);

diff --git a/src/mapboxgl/services/MapService.js b/src/mapboxgl/services/MapService.js
@@ -35,7 +35,7 @@ export class MapService extends ServiceBase {
      * @function MapService.prototype.getMapInfo
      * @description 地图信息查询服务。
      * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
-     * @returns {MapService} 获取服务信息。
+     * @returns {Promise} Promise 对象。
      */
     getMapInfo(callback) {
         var me = this;
@@ -72,7 +72,7 @@ export class MapService extends ServiceBase {
      * @function MapService.prototype.getTilesets
      * @description 切片列表信息查询服务。
      * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
-     * @returns {MapService} 获取服务信息。
+     * @returns {Promise} Promise 对象。
      */
     getTilesets(callback) {
         var me = this;

diff --git a/src/maplibregl/services/MapService.js b/src/maplibregl/services/MapService.js
@@ -35,7 +35,6 @@ export class MapService extends ServiceBase {
      * @function MapService.prototype.getMapInfo
      * @description 地图信息查询服务。
      * @param {RequestCallback} [callback] 回调函数，该参数未传时可通过返回的promise 获取结果。
-     * @returns {MapService} 获取服务信息。
      * @returns {Promise} Promise 对象。
      */
     getMapInfo(callback) {
@@ -74,7 +73,6 @@ export class MapService extends ServiceBase {
      * @function MapService.prototype.getTilesets
      * @description 切片列表信息查询服务。
      * @param {RequestCallback} [callback] 回调函数，该参数未传时可通过返回的promise 获取结果。
-     * @returns {MapService} 获取服务信息。
      * @returns {Promise} Promise 对象。
      */
     getTilesets(callback) {

diff --git a/src/maplibregl/services/ProcessingService.js b/src/maplibregl/services/ProcessingService.js
@@ -74,7 +74,6 @@ export class ProcessingService extends ServiceBase {
      * @description 获取密度分析的状态。
      * @param {string} id - 密度分析的id。
      * @returns {Object} 密度分析的状态。
-     * @returns {Promise} Promise 对象。
      */
     getKernelDensityJobState(id) {
       return this._processingService.getKernelDensityJobState(id);

diff --git a/src/openlayers/services/MapService.js b/src/openlayers/services/MapService.js
@@ -31,7 +31,6 @@ export class MapService extends ServiceBase {
    * @function MapService.prototype.getMapInfo
    * @description 地图信息查询服务。
    * @param {RequestCallback} [callback] 回调函数，该参数未传时可通过返回的promise 获取结果。
-   * @returns {MapService} 获取服务信息。
    * @returns {Promise} Promise 对象。
    */
   getMapInfo(callback) {

diff --git a/src/openlayers/services/ProcessingService.js b/src/openlayers/services/ProcessingService.js
@@ -436,7 +436,7 @@ export class ProcessingService extends ServiceBase {
      * @param {RequestCallback} [callback] 回调函数，该参数未传时可通过返回的promise 获取结果。
      * @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
-     * @returns {Promise} Promise 对象。* @returns {Promise} Promise 对象。
+     * @returns {Promise} Promise 对象。
      */
     addSummaryAttributesJob(params, callback, seconds, resultFormat) {
       params = this._processParams(params);