Export constructors and options of ol.source.Source children

[gberaudo]

Necessary addition to #2749.

[gberaudo]

As the options are not in olx but simply defined using a typedef in the source file, the documentation does not contain details about the options. It may be acceptable though since these are abstract classes and the options are experimental anyway.

new ol.source.Tile(options) experimental
Name Type Description
options ol.source.TileOptions Tile source options.

If it is ok to merge as is, please let me know.
Otherwise moving these options to olx will be done when I get some time for it.
If someone else want to do it please go on.

[tschaub]

Marking a @tyepdef with an @api annotation does not have the same effect as adding it to olx.js. If you do the latter, we get minified property names when compiling together with the application and preserved names when compiling the standalone library. With the changes here, you don't get that.

[elemoine]

When a @typedef is marked with an @api marker a href link is associated to that type in the API doc. But that link will not refer to anything useful in the API doc. So I think the rule is do not mark a @typedef with an @api annotation if the @typedef is not in olx.js.

[elemoine]

As the options are not in olx but simply defined using a typedef in the source file, the documentation does not contain details about the options.

As I said in my previous comment, the API doc will have href links for @typedef's marked with the @api annotation. But these links will be broken. In your case, the link will be /ol.source.html#ImageOptions, but that anchor won't exist in the ol.source.html page.

It may be acceptable though since these are abstract classes and the options are experimental anyway.

The problem is that we don't make a link in the API doc but we want the typedef in the ol-externs.js file.

[elemoine]

See #2765.

[gberaudo]

Removed @api on options. Thanks @elemoine for this simple solution.
Please merge.

[elemoine]

Thanks for updating the patch @gberaudo.