Merge pull request #63 from IGNF/feature-jsdoc-gp

jsdoc sur la variable globale 'Gp'
IGNF · Aug 1, 2018 · a7640ed · a7640ed
2 parents 41d49e4 + d772744
commit a7640ed
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -41,8 +41,6 @@
   "author": "IGNF",
   "license": "CECILL-B",
   "dependencies": {
-    "es6-promise": "^4.2.4",
-    "loglevel": "^1.6.1",
     "request": "^2.87.0",
     "xmldom": "^0.1.27"
   },
@@ -53,6 +51,7 @@
     "chai": "^4.1.2",
     "clean-webpack-plugin": "^0.1.18",
     "copy-webpack-plugin": "^4.5.1",
+    "es6-promise": "^4.2.4",
     "eslint": "^4.18.2",
     "eslint-config-standard": "^11.0.0",
     "eslint-loader": "^2.0.0",
@@ -66,6 +65,7 @@
     "html-webpack-plugin": "^2.30.1",
     "istanbul-instrumenter-loader": "^3.0.1",
     "jsdoc-webpack-plugin": "0.0.1",
+    "loglevel": "^1.6.1",
     "mocha": "^4.0.0",
     "mocha-loader": "^1.1.3",
     "mocha-webpack": "^1.0.1",
@@ -81,5 +81,6 @@
     "webpack-node-externals": "^1.6.0",
     "webpack-shell-plugin": "^0.5.0"
   },
+  "peerDependencies": {},
   "optionalDependencies": {}
 }
diff --git a/src/Gp.js b/src/Gp.js
@@ -1,3 +1,60 @@
+/**
+* Global variable Gp.
+*
+* @module Gp
+* @alias Gp
+* @desc
+*
+* This is the global variable that is exposed in the browser environment.
+* Content is composed of constructor, functions and properties...
+*
+* > Error()
+*     - .TYPE_SRVERR : "SERVICE_ERROR"
+*     - .TYPE_UNKERR : "UNKNOWN_ERROR"
+*     - .TYPE_USEERR : "USAGE_ERROR"
+*
+* > Helper
+*     - .indent()
+*     - .normalyzeParameters()
+*     - .normalyzeUrl()
+*
+* > Protocols
+*     - .XHR.call()
+*
+* > Services
+*     - .Alti
+*         - {@link Gp.Services.Alti.Elevation .Elevation()}
+*     - {@link Gp.Services.AltiResponse .AltiResponse()}
+*     - .AutoComplete
+*         - {@link Gp.Services.AutoComplete.SuggestedLocation .SuggestedLocation()}
+*     - {@link Gp.Services.AutoCompleteResponse .AutoCompleteResponse()}
+*     - {@link Gp.Services.Config .Config()}
+*     - {@link Gp.Services.DefaultUrl .DefaultUrl()}
+*     - .Geocode
+*         - {@link Gp.Services.Geocode.GeocodedLocation .GeocodedLocation()}
+*         - {@link Gp.Services.Geocode.ReverseGeocodedLocation .ReverseGeocodedLocation()}
+*         - {@link Gp.Services.Geocode.DirectGeocodedLocation .DirectGeocodedLocation()}
+*     - {@link Gp.Services.GeocodeResponse .GeocodeResponse()}
+*     - {@link Gp.Services.GetConfigResponse .GetConfigResponse()}
+*     - {@link Gp.Services.IsoCurveResponse .IsoCurveResponse()}
+*     - .Route
+*         - {@link Gp.Services.Route.RouteInstruction .RouteInstruction()}
+*     - {@link Gp.Services.RouteResponse .RouteResponse()}
+*     - {@link module:Services~autoComplete .autoComplete()}
+*     - {@link module:Services~geocode .geocode()}
+*     - {@link module:Services~getAltitude .getAltitude()}
+*     - {@link module:Services~getConfig .getConfig()}
+*     - {@link module:Services~isoCurve .isoCurve()}
+*     - {@link module:Services~reverseGeocode .reverseGeocode()}
+*     - {@link module:Services~route .route()}
+*
+* > servicesDate : "YYYY-MM-DD"
+*
+* > servicesVersion : "X.X.X"
+*
+*
+*/
+
 import Services from "./Services/Services";
 import DefaultUrl from "./Services/DefaultUrlService";
 import AltiResponse from "./Services/Alti/Response/model/AltiResponse";
@@ -35,6 +92,7 @@ var Gp = {
     /**
      * Methode pour rajouter une classe / objet au namespace global.
      *
+     * @private
      * @method extend
      * @param {String} strNS - nom sous lequel on veut présenter la
      *        classe / objet (Gp."strNS").