Remove externs/oli.js

This commit is contained in:
Tim Schaub
2018-05-08 08:38:34 -06:00
parent 750ba4bca4
commit 167bc1ec78
26 changed files with 4 additions and 515 deletions
+1 -2
View File
@@ -10,8 +10,7 @@
"includePattern": ".+\\.js(doc)?$",
"excludePattern": "(^|\\/|\\\\)_",
"include": [
"src",
"externs/oli.js"
"src"
]
},
"plugins": [
+2 -4
View File
@@ -57,10 +57,8 @@ function includeAugments(doclet) {
}
});
}
if (cls.longname.indexOf('oli.') !== 0) {
cls._hideConstructor = true;
delete cls.undocumented;
}
cls._hideConstructor = true;
delete cls.undocumented;
}
}
}
-15
View File
@@ -47,21 +47,6 @@ ol.MapBrowserEventType = {
```
Note the value of the `@event` annotation. The text before the hash refers to the event class that the event belongs to, and the text after the hash is the type of the event.
To export event properties, they need to be defined in `externs/oli.js` (also see `readme.md` in `externs/`) and marked with an @api annotation:
```js
/** @interface */
oli.MapBrowserEvent;
/**
* @type {ol.Coordinate}
* @api
*/
oli.MapBrowserEvent.prototype.coordinate;
// ...
};
```
To document which events are fired by a class or method, the `@fires` annotation is used:
```js
/**