| Index: branches/MwEmbedStandAlone/mwEmbed.js |
| — | — | @@ -87,10 +87,9 @@ |
| 88 | 88 | /** |
| 89 | 89 | * Set a default config value |
| 90 | 90 | * Will only update configuration if no value is present |
| 91 | | - * @param [Mixed] name |
| 92 | | - * {Object} Will iderate through each key and call setDefaultConfig |
| 93 | | - * {String} Will set configuration by string name to value |
| 94 | 91 | * @param [Mixed] value Set configuration name to value |
| | 92 | + * {Object} Will iderate through each key and call setDefaultConfig |
| | 93 | + * {String} Will set configuration by string name to value |
| 95 | 94 | */ |
| 96 | 95 | mw.setDefaultConfig = function( name, value ) { |
| 97 | 96 | if( typeof name == 'object' ) { |
| — | — | @@ -1205,7 +1204,7 @@ |
| 1206 | 1205 | |
| 1207 | 1206 | /** |
| 1208 | 1207 | * Checks if a mw request data requires a post request or not |
| 1209 | | - * @param {Object} |
| | 1208 | + * @param data {Object} |
| 1210 | 1209 | * @return {Boolean} |
| 1211 | 1210 | * true if the request requires a post request |
| 1212 | 1211 | * false if the request does not |
| — | — | @@ -1227,10 +1226,9 @@ |
| 1228 | 1227 | * Check if the url is a request for the local domain |
| 1229 | 1228 | * relative paths are "local" domain |
| 1230 | 1229 | * @param {String} url Url for local domain |
| 1231 | | - * @return |
| | 1230 | + * @return {Boolean} |
| 1232 | 1231 | * true if url domain is local or relative |
| 1233 | 1232 | * false if the domain is |
| 1234 | | - * @type {Boolean} |
| 1235 | 1233 | */ |
| 1236 | 1234 | mw.isLocalDomain = function( url ) { |
| 1237 | 1235 | if( mw.parseUri( document.URL ).host == mw.parseUri( url ).host |
| — | — | @@ -1707,8 +1705,8 @@ |
| 1708 | 1706 | /** |
| 1709 | 1707 | * Get a style sheet and append the style sheet to the DOM |
| 1710 | 1708 | * |
| 1711 | | - * @param {Mixed} |
| 1712 | | - * {String} url Url of the style sheet to be loaded |
| | 1709 | + * @param [Mixed] |
| | 1710 | + * {String} url Url of the style sheet to be loaded |
| 1713 | 1711 | * {Function} callback Function called once sheet is ready |
| 1714 | 1712 | */ |
| 1715 | 1713 | mw.getStyleSheet = function( url , callback) { |
| — | — | @@ -1846,8 +1844,7 @@ |
| 1847 | 1845 | * |
| 1848 | 1846 | * @param {Float} sec Seconds |
| 1849 | 1847 | * @param {Boolean} show_ms If milliseconds should be displayed. |
| 1850 | | - * @return String npt format |
| 1851 | | - * @type {Float} |
| | 1848 | + * @return {Float} String npt format |
| 1852 | 1849 | */ |
| 1853 | 1850 | mw.seconds2npt = function( sec, show_ms ) { |
| 1854 | 1851 | if ( isNaN( sec ) ) { |
| — | — | @@ -1875,8 +1872,7 @@ |
| 1876 | 1873 | * Take hh:mm:ss,ms or hh:mm:ss.ms input, return the number of seconds |
| 1877 | 1874 | * |
| 1878 | 1875 | * @param {String} npt_str NPT time string |
| 1879 | | - * @return Number of seconds |
| 1880 | | - * @type {Float} |
| | 1876 | + * @return {Float} Number of seconds |
| 1881 | 1877 | */ |
| 1882 | 1878 | mw.npt2seconds = function ( npt_str ) { |
| 1883 | 1879 | if ( !npt_str ) { |
| — | — | @@ -2388,10 +2384,9 @@ |
| 2389 | 2385 | * NOTE: this only works for style sheets on the same domain :( |
| 2390 | 2386 | * |
| 2391 | 2387 | * @param {String} styleRule Style rule name to check |
| 2392 | | - * @return |
| 2393 | | - * true if the rule exists |
| 2394 | | - * false if the rule does not exist |
| 2395 | | - * @type {Boolean} |
| | 2388 | + * @return {Boolean} |
| | 2389 | + * true if the rule exists |
| | 2390 | + * false if the rule does not exist |
| 2396 | 2391 | */ |
| 2397 | 2392 | mw.styleRuleExists = function ( styleRule ) { |
| 2398 | 2393 | // Set up the skin paths configuration |
| — | — | @@ -2702,4 +2697,4 @@ |
| 2703 | 2698 | // (this is needed because packaged loader.js files could refrence jQuery ) |
| 2704 | 2699 | if( mw.getScriptLoaderPath() && !window.jQuery ) { |
| 2705 | 2700 | mw.log( 'Error: jQuery is required for mwEmbed, please update your script-loader request' ); |
| 2706 | | -} |
| \ No newline at end of file |
| | 2701 | +} |