Overhaul license comments and file annotations

* Updates all Copyright years to 2015. * Adds licenses annotations to all JS. * Makes all licenses identical to avoid repeated appearance in the compiled output. * Drops fileoverview annotations, which do not affect docs output. * The linter still requires fileoverview on externs. This patch required a newer closure compiler, since the previous version we used had a bug regarding license annotations that caused the license comment block to appear in the output once per file regardless of uniqueness. Change-Id: I2e9272db680cba7ecc4613d97f1d3a94ac2244cc
shaka-project · Sep 8, 2015 · 4cc4e96 · 4cc4e96
1 parent c04ad3e
commit 4cc4e96
Show file tree

Hide file tree

Showing 119 changed files with 273 additions and 363 deletions.
diff --git a/app.js b/app.js
@@ -1,5 +1,6 @@
 /**
- * Copyright 2014 Google Inc.
+ * @license
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,12 +13,13 @@
  * 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.
- *
- * @fileoverview Implements the application layer of the test application.
  */
 
 
-/** @class */
+/**
+ * The application layer of the test application.
+ * @class
+ */
 var app = function() {};
 
 

diff --git a/controls.js b/controls.js
@@ -1,4 +1,5 @@
 /**
+ * @license
  * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,12 +13,13 @@
  * 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.
- *
- * @fileoverview Implements the video controls overlay.
  */
 
 
-/** @class */
+/**
+ * The video controls overlay for the test app.
+ * @class
+ */
 var playerControls = function() {};
 
 

diff --git a/externs/fullscreen.js b/externs/fullscreen.js
@@ -1,5 +1,6 @@
 /**
- * Copyright 2014 Google Inc.
+ * @license
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,7 +13,9 @@
  * 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.
- *
+ */
+
+/**
  * @fileoverview Externs for prefixed fullscreen methods.
  * @externs
  */

diff --git a/externs/htmltrackelement.js b/externs/htmltrackelement.js
@@ -1,5 +1,6 @@
 /**
- * Copyright 2014 Google Inc.
+ * @license
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,8 +13,10 @@
  * 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.
- *
- * @fileoverview HTMLTrackElement externs.
+ */
+
+/**
+ * @fileoverview Externs for HTMLTrackElement.
  * @externs
  */
 

diff --git a/externs/jwk_set.js b/externs/jwk_set.js
@@ -1,5 +1,6 @@
 /**
- * Copyright 2014 Google Inc.
+ * @license
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,7 +13,9 @@
  * 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.
- *
+ */
+
+/**
  * @fileoverview Externs for JWK set.
  * @externs
  */

diff --git a/externs/mediakeys.js b/externs/mediakeys.js
@@ -1,5 +1,6 @@
 /**
- * Copyright 2014 Google Inc.
+ * @license
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,9 +13,12 @@
  * 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.
+ */
+
+/**
+ * @fileoverview Externs for MediaKeys based on
+ * {@link http://goo.gl/blgtZZ EME draft 12 March 2015}
  *
- * @fileoverview MediaKey externs.
- * Based on {@link http://goo.gl/blgtZZ EME draft 12 March 2015}.
  * @externs
  */
 

diff --git a/externs/prefixed_eme.js b/externs/prefixed_eme.js
@@ -1,5 +1,6 @@
 /**
- * Copyright 2014 Google Inc.
+ * @license
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,7 +13,9 @@
  * 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.
- *
+ */
+
+/**
  * @fileoverview Externs for prefixed EME v0.1b.
  * @externs
  */

diff --git a/externs/xmlhttprequest.js b/externs/xmlhttprequest.js
@@ -1,4 +1,5 @@
 /**
+ * @license
  * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,8 +13,12 @@
  * 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.
+ */
+
+/**
+ * @fileoverview Externs for XMLHttpRequest which are missing from the closure
+ * compiler.
  *
- * @fileoverview XMLHttpRequest externs missing from closure.
  * @externs
  */
 

diff --git a/index.css b/index.css
@@ -1,5 +1,5 @@
 /**
- * Copyright 2014 Google Inc.
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/index.html b/index.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 <!--
- Copyright 2014 Google Inc.
+ Copyright 2015 Google Inc.
 
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.

diff --git a/integration_tests.html b/integration_tests.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 <!--
- Copyright 2014 Google Inc.
+ Copyright 2015 Google Inc.
 
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.

diff --git a/lib/dash/container_segment_index_source.js b/lib/dash/container_segment_index_source.js
@@ -1,4 +1,5 @@
 /**
+ * @license
  * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,9 +13,6 @@
  * 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.
- *
- * @fileoverview Implements a SegmentIndexSource that constructs a SegmentIndex
- * from an MP4 or WebM container.
  */
 
 goog.provide('shaka.dash.ContainerSegmentIndexSource');
@@ -34,7 +32,8 @@ goog.require('shaka.util.TypedBind');
 
 
 /**
- * Creates a ContainerSegmentIndexSource.
+ * Creates an ISegmentIndexSource that constructs a SegmentIndex from an MP4 or
+ * WebM container.
  *
  * @param {!shaka.dash.mpd.Mpd} mpd
  * @param {!shaka.dash.mpd.Period} period

diff --git a/lib/dash/duration_segment_index_source.js b/lib/dash/duration_segment_index_source.js
@@ -1,4 +1,5 @@
 /**
+ * @license
  * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,9 +13,6 @@
  * 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.
- *
- * @fileoverview Implements an ISegmentIndexSource that constructs a
- * SegmentIndex from a SegmentTemplate with a segment duration.
  */
 
 goog.provide('shaka.dash.DurationSegmentIndexSource');
@@ -32,7 +30,8 @@ goog.require('shaka.util.TypedBind');
 
 
 /**
- * Creates a DurationSegmentIndexSource.
+ * Creates an ISegmentIndexSource that constructs a SegmentIndex from a
+ * SegmentTemplate with a segment duration.
  *
  * @param {!shaka.dash.mpd.Mpd} mpd
  * @param {!shaka.dash.mpd.Period} period

diff --git a/lib/dash/dynamic_live_segment_index.js b/lib/dash/dynamic_live_segment_index.js
@@ -1,4 +1,5 @@
 /**
+ * @license
  * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,9 +13,6 @@
  * 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.
- *
- * @fileoverview Implements a SegmentIndex that supports live DASH content and
- * dynamically generates SegmentReferences.
  */
 
 goog.provide('shaka.dash.DynamicLiveSegmentIndex');
@@ -28,10 +26,9 @@ goog.require('shaka.util.ArrayUtils');
 
 
 /**
- * Creates a DynamicLiveSegmentIndex.
- *
- * A DynamicLiveSegmentIndex generates SegmentReferences as needed and
- * automatically evicts SegmentReferences that are no longer available.
+ * Creates a SegmentIndex that supports live DASH content by generating
+ * SegmentReferences as needed and automatically evicting SegmentReferences
+ * that are no longer available.
  *
  * If the SegmentIndex's corresponding stream is not available yet then the
  * SegmentIndex will be inactive: it will not contain any SegmentReferences nor

diff --git a/lib/dash/list_segment_index_source.js b/lib/dash/list_segment_index_source.js
@@ -1,4 +1,5 @@
 /**
+ * @license
  * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,9 +13,6 @@
  * 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.
- *
- * @fileoverview Implements an ISegmentIndexSource that constructs a
- * SegmentIndex from a SegmentList.
  */
 
 goog.provide('shaka.dash.ListSegmentIndexSource');
@@ -31,7 +29,8 @@ goog.require('shaka.util.TypedBind');
 
 
 /**
- * Creates a ListSegmentIndexSource.
+ * Creates an ISegmentIndexSource that constructs a SegmentIndex from a
+ * SegmentList.
  *
  * @param {!shaka.dash.mpd.Mpd} mpd
  * @param {!shaka.dash.mpd.Period} period

diff --git a/lib/dash/live_segment_index.js b/lib/dash/live_segment_index.js
@@ -1,4 +1,5 @@
 /**
+ * @license
  * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,8 +13,6 @@
  * 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.
- *
- * @fileoverview Implements a SegmentIndex that supports live DASH content.
  */
 
 goog.provide('shaka.dash.LiveSegmentIndex');
@@ -27,7 +26,7 @@ goog.require('shaka.util.Clock');
 
 
 /**
- * Creates a LiveSegmentIndex.
+ * Creates a SegmentIndex that supports live DASH content.
  *
  * A LiveSegmentIndex automatically evicts SegmentReferences that are no longer
  * available. However, it does not generate any new SegmentReferences.

diff --git a/lib/dash/mpd_parser.js b/lib/dash/mpd_parser.js
@@ -1,5 +1,6 @@
 /**
- * Copyright 2014 Google Inc.
+ * @license
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,8 +13,6 @@
  * 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.
- *
- * @fileoverview Implements a media presentation description object.
  */
 
 goog.provide('shaka.dash.mpd');

diff --git a/lib/dash/mpd_processor.js b/lib/dash/mpd_processor.js
@@ -1,5 +1,6 @@
 /**
- * Copyright 2014 Google Inc.
+ * @license
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,8 +13,6 @@
  * 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.
- *
- * @fileoverview Implements MpdProcessor.
  */
 
 goog.provide('shaka.dash.MpdProcessor');
@@ -1015,7 +1014,7 @@ shaka.dash.MpdProcessor.prototype.validateSegmentTemplate_ = function(
 
 
 /**
- * Creates a SegmentIndexSource from a SegmentTemplate.
+ * Creates an ISegmentIndexSource from a SegmentTemplate.
  *
  * @param {!shaka.dash.mpd.Mpd} mpd
  * @param {!shaka.dash.mpd.Period} period
@@ -1069,7 +1068,7 @@ shaka.dash.MpdProcessor.prototype.makeSegmentIndexSourceViaSegmentTemplate_ =
 
 
 /**
- * Creates a SegmentIndexSource from a SegmentTemplate with an index URL
+ * Creates an ISegmentIndexSource from a SegmentTemplate with an index URL
  * template.
  *
  * @param {!shaka.dash.mpd.Mpd} mpd

diff --git a/lib/dash/mpd_request.js b/lib/dash/mpd_request.js
@@ -1,5 +1,6 @@
 /**
- * Copyright 2014 Google Inc.
+ * @license
+ * Copyright 2015 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,8 +13,6 @@
  * 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.
- *
- * @fileoverview Implements an MPD request.
  */
 
 goog.provide('shaka.dash.MpdRequest');