To link to the docs there is a special link syntax provided by
JSDoc. However, we were using a normal MD link resulting in a
link to a missing resource.
This changes that link to use the JSDoc link.
Fix#1719
Change-Id: I9f1633dbc8e1ac288a55636bd6b98dbff0ec9771
This document goes over the core design principles behind the
localization system. This document is meant to give context on
why decisions were made the way they were and to help guide future
changes.
Bug: b/117679670
Change-Id: I01c3b749f1f9d3707e817f18760e106d22f13b21
Issue #1547 (introduced manifest.dash.ignoreMinBufferTime config)
Issue #1666 (in which ignoreMinBufferTime is discussed as a solution)
Change-Id: I895dc136ab7a4900ee74ff8ebe60b2bc194efe32
In the "Talking About Languages" doc, the links to the images
were broken. It appears that there were minor typos in the paths
that caused images to not be found. The change updates the links
rather than the file names to avoid breaking other documents that
may reference these same images.
Issue #1691
Change-Id: I2874c8e920b1dd66f8d3a276f19953f17a999c5b
This replaces almost every instance of indexOf on both String and
Array. There are very few places where we really wanted an index.
Mostly, indexOf was used to check for inclusion.
Change-Id: I08e299768b6ffdb4bfc30b39b5d82a058c6d1b56
At some point, a compiler upgrade introduced a built-in polyfill for
Promise. A third-party polyfill for Promises on IE11 is no longer
required.
Change-Id: Ie5a649232d949b0bba0c6c68ea54ceed6fb30891
This change tried to make our recommendation for using async/await
easier to read by breaking it up a bit. Also changing the wording to
be more "we recommend because".
Change-Id: Ie0adce7e66a1bfd0a51bbc559094ebba98e0202f
https://goo.gl is being turned-down, so we can't use it for new URLS.
So we have consistent short links, this converts them to be
https://bit.ly.
Change-Id: I07a86cba807b67157664893341f648023918d0de
- Fix some links.
- Add exportDoc to externs members so they appear in the documentation.
- Fix `shaka.extern` namespace so it appears in sidebar.
Change-Id: I4bdbf5083180d6d64a69c8d0dfd1b2d52f3f78c0
Originally, docs were slow to build, and many people did not need a
local copy. Now, building the docs is fast, and doing everything as
part of "all" is less surprising.
Closes#1421
Change-Id: I5ac254df9d2beca8c1c5898614782a81e662a0e9
According to @beaufortfrancois, we should no longer be using protocol-
relative URIs. He quotes this passage from Paul Irish:
> Now that SSL is encouraged for everyone and doesn’t have performance
> concerns, this technique is now an anti-pattern. If the asset you
> need is available on SSL, then always use the https:// asset.
> Allowing the snippet to request over HTTP opens the door for attacks
> like the recent Github Man-on-the-side attack. It’s always safe to
> request HTTPS assets even if your site is on HTTP, however the
> reverse is not true.
Source: https://www.paulirish.com/2010/the-protocol-relative-url/
This change was begun with the following command:
git grep -l "'//" | xargs sed -i "s@'//@'https://@g"
Some changes made by that command were false-positives, which I then
reverted manually. Others required additional cleanup to meet style
rules.
I've also just discovered that the "max-len" rule in eslint's Google
style config exempts URIs, so there's no need to disable the max-len
rule on URIs in the assets list. These have been removed in the asset
list where unnecessary.
Finally, testing these updated URIs led to the discovery that two of
our third-party demo assets are no longer available. One URI needed
to be updated. The other had no obvious replacement, so it was
removed.
Closes#1390
Change-Id: I2fe23faec04f1904c1741236b364d5089900092a
This is required by Google policy, to document where these forks came
from and what their licensing terms are. I overlooked this detail
when I started customizing the JSDoc template.
Change-Id: Ifd18bb3143ca841e2bd934fe571f3a896ba53975
This updates the existing diagrams and adds new ones for cast and
offline. The offline diagrams will need to be updated again after
we resolve#1248.
Closes#1197
Change-Id: I6b6b1fac732b4997c579f58c7f12f0f84f202380
Now each EME polyfill can be removed independently; this allows
someone to remove just the IE11 polyfill while still keeping the
others.
This adds a priority ordering to the polyfills so the nop polyfill
will be run last as a fallback if there are no other polyfills.
Issue #1261
Change-Id: I865e1c0d6a73a079dd91505e96572e215e6f6c6a
This adds a new script which should simplify the process of installing
prereqs on Debian and Ubuntu-based Linux distributions. This also
updates the required versions of NodeJS and Git.
Closes#1175
Change-Id: If298cc46650bfd0ebe726c8fa3184dd0d063bfaf
Instead of using the uncompiled library, which some app developers
have been confused about, recommend the use of the much simpler debug
library, which offers many of the same advantages.
Thanks to @jpmedley for pointing out the complexities of using the
uncompiled build.
Change-Id: I771a2b5a98152a67807629538d8537721177399f
This plugin is preferred over the XHR plugin, if available.
This plugin requires AbortController, which is only present on
Firefox 57 and Edge 16, so this will not be active on every platform.
This also adds a simple mock for the Fetch API for use with Jasmine.
Closes#829
Change-Id: Ifb79d29334fbfcfd175afe0706da5a3d5e452e2f
This feature is based on a forked version of jsdoc which we hope to
land https://github.com/jsdoc3/jsdoc/pull/1502 upstream.
Closes#1259
Change-Id: I48e07ffd8ae9fc2c07cd48b3e02b85e87694d341
Replace generic "function" and "record" types with their original types.
With this, we see, for example:
"function(string):number" instead of just "function"
"{{ foo: string, bar: number }}" instead of just "Object"
Issue #1259
Change-Id: Icd5ddbacadb7ec799e025b67f311792dd590b310
This adds custom CSS classes and a widget to show/hide various parts
of the docs. By default, we show exported interfaces only. The user
can also select "public" (all public interfaces, even those not
exported), and "everything" (even private members).
Issue #1259
Change-Id: Iff8f4d84658a3d19ad8f2f979ab37b256393589f
This is a customization that allows us to link to the source code of
a thing, rather than its documentation.
Redoing this in a clean way caught some bad links, which have now been
fixed.
Issue #1259
Change-Id: I4c63aa10ddad8f8f21b224668c3529c70a1c6756
We now show enum values in the generated documentation. Further, a
URL fragment of "value:6001", for example, would highlight and scroll
directly to the row in which value 6001 is described. This is used
by the demo app to take users directly to the appropriate docs for a
given error code.
Issue #1259
Change-Id: Iae47e661db2bba43eb16a4f3fd1476adea59aecb
- always show Constructor heading for class constructors
- hide top-level header that just repeats information from elsewhere
- show namespace descriptions as a "class description" at the top
- remove 2 redundant headers from tutorials that repeat the title
- use a gray background for inline code, as github does
- put more space between headings within a tutorial
Issue #1259
Change-Id: I7eedd69b7a732da0f3292912ec07d97eccb44eed
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
This uses a plugin to customize certain tags in jsdoc.
In some cases, we have invented new tags in our build system.
In others, we want to the docs to treat things differently than the
build.
Issue #1259
Change-Id: I934ad578cf7479572cb807c5b3aee489c332343a
We can now specify in a config file what order the nav elements should
be in, and which nav elements should appear.
Issue #1259
Change-Id: I4caa3a0585b4140e76a66f1c5bed0c20c82ca5a4
This updates jsdoc to the latest version from npm and forks a copy of
the default jsdoc template.
In subsequent commits, we will reapply our customizations to the
template and to a jsdoc plugin.
This also fixes several bad annotations that the new jsdoc failed to
parse.
Issue #1259
Change-Id: I00a47270ea4754e1c96c43ca900d5cf889ab72e6
A bug in our Promise polyfill caused issues with the recently-added
AbortableOperation class on IE11. Since external polyfills for this
are smaller, it is easier to remove ours in favor of a third-party
polyfill. Applications that wish to support IE11 must now load this
additional polyfill.
We are using the "es6-promise-polyfill" module from npm, but any
compliant polyfill should suffice.
One feature our own polyfill offered was the ability to flush all
Promises, which allowed us to write synchronous unit tests that
simulated async processes. To get this ability back, we are now
using the "promise-mock" module in our tests.
Getting "promise-mock" to load correctly involved switching from
"requirejs" to "cajon", which builds on requirejs and supports
AMD modules more directly.
Closes#1260
Change-Id: I5de48e88a910736ae5c1897a7a509bc5641acb70
When playing manifests with segments longer than bufferBehind, while
gap jumping is enabled, there can be issues where the streaming engine
evicts the frames of the segment currently playing, thus creating a
gap that is then jumped.
This change makes the streaming engine use bufferBehind or
maxSegmentSize, whichever is larger, when choosing when to evict
segments.
It also adds a getter for maxSegmentSize on presentationTimeline.
Closes#1123
Change-Id: I83459c5eb3ebb1d6dff031e2bc244ac9fc3b5763
This uses AbortableOperation in all networking, from the scheme
plugins all the way to the request interface.
This also updates all default scheme plugins, docs, and sample code.
Backward compatibility is provided for scheme plugins and the
request API in NetworkingEngine. This compatibility will be
removed in v2.5.
Two cancelation-related tests have been disabled in
player_integration until the new abort interface has been adopted
in the manifest parsers.
Issue #829
Change-Id: I91c8e6efe97798d111e8ddca5655cddc1f6bcbf3
Aaron Vaage
Joey Parrish
Sandra Lokshina
Gi Gi
Jacob Trimble
Michelle Zhuo
Theodore Abshire