List subclasses for each class

With this change, we no longer need to link to implementations
or subclasses manually.
This commit is contained in:
Andreas Hocevar
2014-05-03 15:32:39 -04:00
parent db5b2e284a
commit 0f072c0ec1
6 changed files with 26 additions and 15 deletions

View File

@@ -43,6 +43,20 @@
<?js } ?>
</div>
<?js if (doc.kind == 'class') {
var subclasses = self.find(function() {
return this.augments && this.augments.indexOf(doc.longname) > -1;
})
if (subclasses.length) {
?>
<h3 class="subsection-title">Subclasses</h3>
<ul><?js subclasses.forEach(function(s) { ?>
<li><?js= self.linkto(s.longname, s.longname) ?>
<?js= (s.interface ? '(Interface)' : '') ?>
</li>
<?js }); ?></ul>
<?js } } ?>
<?js if (doc.augments && doc.augments.length) { ?>
<h3 class="subsection-title">Extends</h3>
@@ -67,7 +81,7 @@
<li><?js= self.linkto(r, r) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js
var classes = self.find({kind: 'class', memberof: doc.longname});
if (doc.kind !== 'globalobj' && classes && classes.length) {

View File

@@ -156,8 +156,7 @@ olx.MapOptions.prototype.keyboardEventTarget;
/**
* Layers. Array or {@link ol.Collection} items are instances of
* {@link ol.layer.Layer} or any of its {@link ol.layer} subclasses.
* Layers.
* @type {Array.<ol.layer.Base>|ol.Collection|undefined}
*/
olx.MapOptions.prototype.layers;
@@ -192,7 +191,7 @@ olx.MapOptions.prototype.target;
/**
* The map's view. Currently {@link ol.View2D} is available as view.
* The map's view.
* @type {ol.IView|undefined}
*/
olx.MapOptions.prototype.view;

View File

@@ -19,9 +19,9 @@ goog.require('ol.interaction.PinchZoom');
* setting the appropriate option to false in the constructor options,
* but the order of the interactions is fixed. If you want to specify a
* different order for interactions, you will need to create your own
* {@link ol.interaction} instances and insert them into an
* {@link ol.Collection} in the order you want before creating your ol.Map
* instance.
* {@link ol.interaction.Interaction} instances and insert them into a
* {@link ol.Collection} in the order you want before creating your
* {@link ol.Map} instance.
* @param {olx.interaction.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} A collection of interactions to be used with
* the ol.Map constructor's interactions option.

View File

@@ -6,7 +6,7 @@ goog.require('ol.IView3D');
/**
* Interface for views. Currently {@link ol.View2D} is implemented.
* Interface for views.
* @interface
*/
ol.IView = function() {

View File

@@ -41,8 +41,7 @@ ol.layer.LayerState;
/**
* Base class for all layers. The most basic implementation is
* {@link ol.layer.Layer}. See {@link ol.layer} for all implementations.
* Base class for all layers.
* @constructor
* @extends {ol.Object}
* @param {olx.layer.BaseOptions} options Layer options.

View File

@@ -662,13 +662,12 @@ ol.Map.prototype.getOverlays = function() {
/**
* Gets the collection of
* {@link ol.interaction|ol.interaction.Interaction} instances
* associated with this map. Modifying this collection
* changes the interactions associated with the map.
* Gets the collection of {@link ol.interaction.Interaction} instances
* associated with this map. Modifying this collection changes the interactions
* associated with the map.
*
* Interactions are used for e.g. pan, zoom and rotate.
* @return {ol.Collection} Interactions.
* @return {ol.Collection} {@link ol.interaction.Interaction Interactions}.
* @todo api
*/
ol.Map.prototype.getInteractions = function() {