mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-14 15:56:38 +03:00
Joey Parrish
b0d6a3e23d
The docs template already shows this, but for some reason, it is not populated anywhere. Our plugin takes care of this. Issue #1259 Change-Id: Ifd4233e5b7b9ca5abb1aec681ae1b12c8a895d44
80 lines
2.5 KiB
JavaScript
80 lines
2.5 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2016 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
// JSDoc plugin to customize jsdoc for Shaka Player
|
|
|
|
'use strict';
|
|
|
|
// Define custom tags.
|
|
exports.defineTags = function(dictionary) {
|
|
let exportOpts = {
|
|
mustNotHaveValue: true,
|
|
onTagged: function(doclet, tag) {
|
|
doclet.access = 'export';
|
|
},
|
|
};
|
|
|
|
// Truly exported by the compiler.
|
|
dictionary.defineTag('export', exportOpts);
|
|
// Interface exported in the generated externs only.
|
|
dictionary.defineTag('exportInterface', exportOpts);
|
|
// A namespace, event, etc. exported only in the docs.
|
|
dictionary.defineTag('exportDoc', exportOpts);
|
|
|
|
// For use @namespace should be treated like @class, except that we don't
|
|
// want to show the non-existent constructor.
|
|
let classOpts = dictionary.lookUp('class');
|
|
dictionary.defineTag('namespace', {
|
|
onTagged: function(doclet, tag) {
|
|
classOpts.onTagged(doclet, tag);
|
|
doclet.hideconstructor = true;
|
|
},
|
|
});
|
|
};
|
|
|
|
exports.handlers = {
|
|
processingComplete: function(e) {
|
|
// Fill out the "implementations" field so that interface implementations
|
|
// can be listed on the interface docs.
|
|
|
|
let doclets = e.doclets;
|
|
let map = {};
|
|
doclets.forEach(function(doc) {
|
|
map[doc.longname] = doc;
|
|
});
|
|
|
|
doclets.forEach(function(doc) {
|
|
// Skip things that do not implement an interface.
|
|
if (!doc.implements) return;
|
|
// Skip things which are not classes (such as methods).
|
|
if (doc.kind != 'class') return;
|
|
|
|
doc.implements.forEach(function(interfaceName) {
|
|
// If the interface is a template, strip the template type.
|
|
interfaceName = interfaceName.split('.<')[0];
|
|
|
|
var interfaceDoc = map[interfaceName];
|
|
// Skip unknown interfaces, which occurs for externs like MediaKeys.
|
|
if (!interfaceDoc) return;
|
|
|
|
interfaceDoc.implementations = interfaceDoc.implementations || [];
|
|
interfaceDoc.implementations.push(doc.longname);
|
|
});
|
|
});
|
|
},
|
|
};
|