r66627 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r66626‎ | r66627 | r66628 >
Date:21:12, 18 May 2010
Author:papyromancer
Status:deferred
Tags:
Comment:
closure compatibility of EmbedPlayer module achievement unlocked
Modified paths:
  • /branches/MwEmbedStandAlone/modules/EmbedPlayer/mw.EmbedPlayer.js (modified) (history)
  • /branches/MwEmbedStandAlone/modules/EmbedPlayer/omtkEmbed.js (modified) (history)
  • /branches/MwEmbedStandAlone/modules/EmbedPlayer/vlcEmbed.js (modified) (history)

Diff [purge]

Index: branches/MwEmbedStandAlone/modules/EmbedPlayer/omtkEmbed.js
@@ -83,7 +83,7 @@
8484 if ( this.playerElement.play ) {
8585 // mw.log('omtk obj is missing .play (probably not omtk obj)');
8686 }
87 - },
 87+ }
8888 }
8989 // Some auto-called globals (bad)
9090 function OMTK_P_complete() {
Index: branches/MwEmbedStandAlone/modules/EmbedPlayer/mw.EmbedPlayer.js
@@ -239,13 +239,13 @@
240240 *
241241 * Rewrites all tags via a given selector
242242 *
243 - * @param [ Optional ] {Object} attributes The embedPlayer options for the given video interface.
 243+ * @param {Object} attributes [ Optional ] The embedPlayer options for the given video interface.
244244 * Attributes Object can inclued any key value pair that would otherwise be
245245 * an attribute in the html element.
246246 *
247247 * also see: mw.getConfig( 'embedPlayerAttributes' )
248248 *
249 - * @param [ Optional ] {Function} callback Function to be called once video interfaces are ready
 249+ * @param {Function} callback [ Optional ] Function to be called once video interfaces are ready
250250 *
251251 */
252252 $.fn.embedPlayer = function( attributes, callback ) {
@@ -779,8 +779,7 @@
780780
781781 /**
782782 * Title accessor function.
783 - * @return Title of the source.
784 - * @type String
 783+ * @return {String} Title of the source.
785784 */
786785 getTitle : function() {
787786 if( this.title ){
@@ -808,8 +807,7 @@
809808 },
810809
811810 /** Index accessor function.
812 - * @return the source's index within the enclosing mediaElement container.
813 - * @type Integer
 811+ * @return {Integer} the source's index within the enclosing mediaElement container.
814812 */
815813 getIndex : function() {
816814 return this.index;
@@ -846,8 +844,7 @@
847845 /**
848846 * Attempts to detect the type of a media file based on the URI.
849847 * @param {String} uri URI of the media file.
850 - * @return The guessed MIME type of the file.
851 - * @type String
 848+ * @return {String} The guessed MIME type of the file.
852849 */
853850 detectType: function( uri ) {
854851 // NOTE: if media is on the same server as the javascript
@@ -957,8 +954,7 @@
958955
959956 /**
960957 * Check for Timed Text tracks
961 - * @return True if text tracks exist, false if no text tracks are found
962 - * @type Boolean
 958+ * @return {Boolean} True if text tracks exist, false if no text tracks are found
963959 */
964960 textSourceExists: function() {
965961 for ( var i = 0; i < this.sources.length; i++ ) {
@@ -976,8 +972,7 @@
977973 * Returns the array of mediaSources of this element.
978974 *
979975 * @param {String} [mime_filter] Filter criteria for set of mediaSources to return
980 - * @return mediaSource elements.
981 - * @type Array
 976+ * @return {Array} mediaSource elements.
982977 */
983978 getSources: function( mimeFilter ) {
984979 if ( !mimeFilter ) {
@@ -2891,7 +2886,7 @@
28922887 * mediaPlayer represents a media player plugin.
28932888
28942889 * @param {String} id id used for the plugin.
2895 - * @param {Array<String>} supported_types n array of supported MIME types.
 2890+ * @param {Array} supported_types an array of supported MIME types.
28962891 * @param {String} library external script containing the plugin interface code.
28972892 * @constructor
28982893 */
@@ -3370,4 +3365,4 @@
33713366 }
33723367 return hasObj;
33733368 }
3374 -};
\ No newline at end of file
 3369+};
Index: branches/MwEmbedStandAlone/modules/EmbedPlayer/vlcEmbed.js
@@ -313,8 +313,7 @@
314314
315315 /**
316316 * Gets the current volume
317 - * @return percent percent of total volume
318 - * @type {Float}
 317+ * @return {Float} percent percent of total volume
319318 */
320319 getVolumen:function() {
321320 if ( this.getPlayerElement() )

Status & tagging log