Documentation fixes

maplibre · Dec 22, 2015 · 94353b1 · 94353b1
1 parent 875b859
commit 94353b1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/js/style/style.js b/js/style/style.js
@@ -317,9 +317,10 @@ Style.prototype = util.inherit(Evented, {
     },
 
     /**
-     * Get a layer by id.
-     * @param {string} id id of the desired layer
-     * @returns {Layer} layer
+     * Return the style layer object with the given `id`.
+     *
+     * @param {string} id - id of the desired layer
+     * @returns {?Object} a layer, if one with the given `id` exists
      * @private
      */
     getLayer: function(id) {

diff --git a/js/ui/map.js b/js/ui/map.js
@@ -503,8 +503,9 @@ util.extend(Map.prototype, /** @lends Map.prototype */{
      * specified layer via a `ref` property are also removed.
      *
      * @param {string} id layer id
+     * @throws {Error} if no layer with the given `id` exists
      * @fires layer.remove
-     * @returns {Map} this
+     * @returns {Map} `this`
      */
     removeLayer: function(id) {
         this.style.removeLayer(id);
@@ -515,8 +516,8 @@ util.extend(Map.prototype, /** @lends Map.prototype */{
     /**
      * Return the style layer object with the given `id`.
      *
-     * @param {string} id layer ID
-     * @returns {Object}
+     * @param {string} id layer id
+     * @returns {?Object} a layer, if one with the given `id` exists
      */
     getLayer: function(id) {
         return this.style.getLayer(id);