Mattflaschen has uploaded a new change for review. https://gerrit.wikimedia.org/r/68137
Change subject: Cleanup jsduck documentation and commenting: ...................................................................... Cleanup jsduck documentation and commenting: * Fix jsduck config to document mw.guidedTour.internal correctly * Move comments to before docblock, which jsduck requires * Add text for licenses we're using * Import MetaTags.rb and external.js from VisualEditor under MIT Change-Id: I46e103c1a559200deea284245dc96bbe17600994 --- A .docs/MetaTags.rb M .docs/config.json A .docs/external.js A APACHE-2.0-LICENSE.txt A MIT-LICENSE.txt M README M modules/ext.guidedTour.lib.internal.js M modules/ext.guidedTour.lib.js 8 files changed, 404 insertions(+), 16 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/GuidedTour refs/changes/37/68137/1 diff --git a/.docs/MetaTags.rb b/.docs/MetaTags.rb new file mode 100644 index 0000000..22e0f3b --- /dev/null +++ b/.docs/MetaTags.rb @@ -0,0 +1,117 @@ +# See also: +# - https://github.com/senchalabs/jsduck/wiki/Tags +# - https://github.com/senchalabs/jsduck/wiki/Custom-tags +require 'jsduck/meta_tag' + +class SourceTag < JsDuck::MetaTag + def initialize + # This defines the name of the @tag + @name = 'source' + end + + # Generate HTML output for this tag. + # One can make use of the #format method to easily support + # Markdown and {@link} tags inside the contents of the tag. + # + # @param tags All matches of this tag on one class. + def to_html(tags) + '<h3 class="pa">Source</h3>' + tags.map {|tag| format(tag) }.join("\n") + end +end + +class UntilTag < JsDuck::MetaTag + def initialize + @name = 'until' + end + + # @param tags All matches of this tag on one class. + def to_html(tags) + return [ + '<h3>Until</h3>', + '<div class="signature-box"><p>', + 'This method provides <strong>browser compatibility</strong> for:', + tags.map {|tag| format(tag) }.join("\n"), + '</p></div>' + ] + end +end + +class SeeTag < JsDuck::MetaTag + def initialize + @name = 'see' + @multiline = true + end + + # @param tags All matches of this tag on one class. + def to_html(tags) + doc = [] + doc << '<h3 class="pa">Related</h3>' + doc << [ + '<ul>', + tags.map {|tag| render_long_see(tag) }, + '</ul>', + ] + doc + end + + def render_long_see(tag) + if tag =~ /\A([^\s]+)( .*)?\Z/m + name = $1 + doc = $2 ? ': ' + $2 : '' + return [ + '<li>', + format("{@link #{name}} #{doc}"), + '</li>' + ] + end + end +end + +class ContextTag < JsDuck::MetaTag + def initialize + @name = 'this' + end + + # @param tags All matches of this tag on one class. + def to_html(tags) + return '<h3 class="pa">Context</h3>' + render_long_context(tags.last) + end + + def render_long_context(tag) + if tag =~ /\A([^\s]+)/m + name = $1 + return format("`this` : {@link #{name}}") + end + end +end + +class EmitsTag < JsDuck::MetaTag + def initialize + @name = 'emits' + @multiline = true + end + + # @param tags All matches of this tag on one class. + def to_html(tags) + doc = [] + doc << '<h3 class="pa">Emits</h3>' + doc << [ + '<ul>', + tags.map {|tag| render_long_event(tag) }, + '</ul>', + ] + doc + end + + def render_long_event(tag) + if tag =~ /\A(\w+)( .*)?\Z/m + name = $1 + doc = $2 ? ': ' + $2 : '' + return [ + '<li>', + format("{@link #event-#{name}} #{doc}"), + '</li>' + ] + end + end +end diff --git a/.docs/config.json b/.docs/config.json index 9a36b39..bfabfb8 100644 --- a/.docs/config.json +++ b/.docs/config.json @@ -1,10 +1,13 @@ { "--title": "GuidedTour Code Documentation", "--warnings": ["-no_doc"], + "--meta-tags": "./MetaTags.rb", "--builtin-classes": true, "--output": "../docs", "--": [ + "./external.js", "../modules/ext.guidedTour.lib.js", + "../modules/ext.guidedTour.lib.internal.js", "../modules/externals/mediawiki.libs.guiders/mediawiki.libs.guiders.exposeGuiders.js", "../tests/" ] diff --git a/.docs/external.js b/.docs/external.js new file mode 100644 index 0000000..6d87218 --- /dev/null +++ b/.docs/external.js @@ -0,0 +1,37 @@ +/** + * @class jQuery + * @source <http://api.jquery.com/> + */ + +/** + * @method ajax + * @source <http://api.jquery.com/jQuery.ajax/> + * @return {jqXHR} + */ + +/** + * @class jQuery.Event + * @source <http://api.jquery.com/Types/#Event> + */ + +/** + * @class jQuery.Promise + * @source <http://api.jquery.com/Types/#Promise> + */ + +/** + * @class jQuery.Deferred + * @mixins jQuery.Promise + * @source <http://api.jquery.com/jQuery.Deferred/> + */ + +/** + * @class jQuery.jqXHR + * @source <http://api.jquery.com/Types/#jqXHR> + * @alternateClassName jqXHR + */ + +/** + * @class QUnit + * @source <http://api.qunitjs.com/> + */ diff --git a/APACHE-2.0-LICENSE.txt b/APACHE-2.0-LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/APACHE-2.0-LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/MIT-LICENSE.txt b/MIT-LICENSE.txt new file mode 100644 index 0000000..54955a1 --- /dev/null +++ b/MIT-LICENSE.txt @@ -0,0 +1,20 @@ +Copyright (c) 2011-2013 VisualEditor Team, E3 team and others: + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README b/README index ce38949..46f2d7c 100644 --- a/README +++ b/README @@ -31,5 +31,14 @@ License -This is free software. You may use, modify and distribute it under the terms of -the Apache License 2.0. http://www.apache.org/licenses/LICENSE-2.0.html +This is free software. + +For the main GuidedTour code and Guiders: + +You may use, modify and distribute it under the terms of +the Apache License 2.0. + +For the .docs dir, the MIT license applies: + +Copyright (c) 2011-2013 VisualEditor Team, E3 team and others under the terms +of The MIT License. diff --git a/modules/ext.guidedTour.lib.internal.js b/modules/ext.guidedTour.lib.internal.js index eadd665..56f1396 100644 --- a/modules/ext.guidedTour.lib.internal.js +++ b/modules/ext.guidedTour.lib.internal.js @@ -18,6 +18,10 @@ var internal; mw.guidedTour = { + /** + * @class mw.guidedTour.internal + * @singleton + */ internal: { /** * Returns a promise that waits for all input deferreds. @@ -32,7 +36,7 @@ * * @param {Array} deferreds array of deferreds to wait for * - * @return {Promise} promise behaving as above + * @return {jQuery.Promise} promise behaving as above */ alwaysWaitForAll: function ( deferreds ) { var dfd, unresolved, allSucceeded, i; @@ -69,8 +73,6 @@ /** * Gets CSS class for tour name * - * @private - * * @param {string} tourName * * @return {string} CSS class @@ -81,8 +83,6 @@ /** * Gets the tour module name. This does not guarantee there is such a module. - * - * @private * * @param {string} tourName Tour name * @@ -97,7 +97,7 @@ * * @param {string} tourName name of tour to load * - * @return {Promise} Promise that resolves on successful load and + * @return {jQuery.Promise} Promise that resolves on successful load and * rejects on failure. */ loadExtensionTour: function ( tourName ) { @@ -123,7 +123,7 @@ * * @param {string} tourName name of tour to load * - * @return {Promise} Promise that resolves on successful load and + * @return {jQuery.Promise} Promise that resolves on successful load and * rejects on failure. */ loadOnWikiTour: function ( tourName ) { @@ -171,7 +171,7 @@ * * @param {string} tourName name of tour to load * - * @return {Promise} Promise that resolves on successful load andx + * @return {jQuery.Promise} Promise that resolves on successful load andx * rejects on failure. */ loadTour: function ( tourName ) { @@ -192,7 +192,7 @@ * * @param {Array} tourNames array of tour names to load * - * @return {Promise} Promise. It will resolve if all attempts + * @return {jQuery.Promise} Promise. It will resolve if all attempts * succeed, and reject if any fail. Either way, it will wait * until all load attempts are complete. */ diff --git a/modules/ext.guidedTour.lib.js b/modules/ext.guidedTour.lib.js index a72dd62..ea4013e 100644 --- a/modules/ext.guidedTour.lib.js +++ b/modules/ext.guidedTour.lib.js @@ -221,6 +221,7 @@ return mw.util.rawurlencode( tourName.replace( /^(?:\.\.\/)+/, '' ) ); } + // TODO (mattflaschen, 2013-06-02): This should be changed to take a guider as parameter. /** * Logs a dismissal event. * @@ -228,7 +229,6 @@ * * @return {void} */ - // TODO (mattflaschen, 2013-06-02): This should be changed to take a guider as parameter. function logDismissal() { pingServer( 'hide', guiders._lastCreatedGuiderID ); } @@ -1191,6 +1191,10 @@ } ) ); }, + // TODO (mattflaschen, 2013-06-02): Ideally, this would do all of the + // option normalization, and validate all of the input, so + // initializeGuiderInternal wouldn't need to throw. Invalid input should + // throw even if the tour is not shown on this page. /** * Creates a tour based on an object specifying it, but does not show * it immediately @@ -1326,10 +1330,6 @@ * @return {boolean} true, on success; throws otherwise * @throws {mw.guidedTour.TourDefinitionError} On invalid input */ - // TODO (mattflaschen, 2013-06-02): Ideally, this would do all of the - // option normalization, and validate all of the input, so - // initializeGuiderInternal wouldn't need to throw. Invalid input should - // throw even if the tour is not shown on this page. defineTour: function ( tourSpec ) { var steps, stepInd = 0, stepCount, id, defaults = {}; -- To view, visit https://gerrit.wikimedia.org/r/68137 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I46e103c1a559200deea284245dc96bbe17600994 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/GuidedTour Gerrit-Branch: master Gerrit-Owner: Mattflaschen <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
