diff options
author | Alexander Sulfrian <alexander@sulfrian.net> | 2010-06-08 09:01:43 +0200 |
---|---|---|
committer | Alexander Sulfrian <alexander@sulfrian.net> | 2010-06-08 09:01:43 +0200 |
commit | d1fa08fdc9cb11dccee76d668ff85df30458c295 (patch) | |
tree | 1d19df6405103577d872902486792e8c23bce711 /infrastructure/rhino1_7R1/examples/checkParam.js | |
parent | d7c5ad7d6263fd1baf9bfdbaa4c50b70ef2fbdb2 (diff) | |
parent | 70d1f9d6fcaefe611e778b8dbf3bafea8934aa08 (diff) | |
download | etherpad-d1fa08fdc9cb11dccee76d668ff85df30458c295.tar.gz etherpad-d1fa08fdc9cb11dccee76d668ff85df30458c295.tar.xz etherpad-d1fa08fdc9cb11dccee76d668ff85df30458c295.zip |
Merge remote branch 'upstream/master'
Conflicts:
etherpad/src/etherpad/control/pro/admin/pro_admin_control.js
etherpad/src/etherpad/control/pro/pro_main_control.js
etherpad/src/etherpad/control/pro_help_control.js
etherpad/src/etherpad/globals.js
etherpad/src/etherpad/legacy_urls.js
etherpad/src/etherpad/pne/pne_utils.js
etherpad/src/etherpad/pro/pro_utils.js
etherpad/src/main.js
etherpad/src/plugins/fileUpload/templates/fileUpload.ejs
etherpad/src/plugins/testplugin/templates/page.ejs
etherpad/src/static/css/pad2_ejs.css
etherpad/src/static/css/pro-help.css
etherpad/src/static/img/jun09/pad/protop.gif
etherpad/src/static/js/store.js
etherpad/src/themes/default/templates/framed/framedheader-pro.ejs
etherpad/src/themes/default/templates/main/home.ejs
etherpad/src/themes/default/templates/pro-help/main.ejs
etherpad/src/themes/default/templates/pro-help/pro-help-template.ejs
infrastructure/com.etherpad/licensing.scala
trunk/etherpad/src/etherpad/collab/ace/contentcollector.js
trunk/etherpad/src/etherpad/collab/ace/linestylefilter.js
trunk/etherpad/src/static/css/home-opensource.css
trunk/etherpad/src/static/js/ace.js
trunk/etherpad/src/static/js/linestylefilter_client.js
trunk/etherpad/src/templates/email/eepnet_license_info.ejs
trunk/etherpad/src/templates/pad/pad_body2.ejs
trunk/etherpad/src/templates/pad/pad_content.ejs
trunk/etherpad/src/templates/pad/padfull_body.ejs
trunk/etherpad/src/templates/pro/admin/pne-license-manager.ejs
Diffstat (limited to 'infrastructure/rhino1_7R1/examples/checkParam.js')
-rw-r--r-- | infrastructure/rhino1_7R1/examples/checkParam.js | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/infrastructure/rhino1_7R1/examples/checkParam.js b/infrastructure/rhino1_7R1/examples/checkParam.js new file mode 100644 index 0000000..51910d5 --- /dev/null +++ b/infrastructure/rhino1_7R1/examples/checkParam.js @@ -0,0 +1,137 @@ +/* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- + * + * ***** BEGIN LICENSE BLOCK ***** + * Version: MPL 1.1/GPL 2.0 + * + * The contents of this file are subject to the Mozilla Public License Version + * 1.1 (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.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the + * License. + * + * The Original Code is Rhino code, released + * May 6, 1999. + * + * The Initial Developer of the Original Code is + * Netscape Communications Corporation. + * Portions created by the Initial Developer are Copyright (C) 1997-1999 + * the Initial Developer. All Rights Reserved. + * + * Contributor(s): + * Norris Boyd + * + * Alternatively, the contents of this file may be used under the terms of + * the GNU General Public License Version 2 or later (the "GPL"), in which + * case the provisions of the GPL are applicable instead of those above. If + * you wish to allow use of your version of this file only under the terms of + * the GPL and not to allow others to use your version of this file under the + * MPL, indicate your decision by deleting the provisions above and replacing + * them with the notice and other provisions required by the GPL. If you do + * not delete the provisions above, a recipient may use your version of this + * file under either the MPL or the GPL. + * + * ***** END LICENSE BLOCK ***** */ + +/** + * checkParam.js + * + * The files given as arguments on the command line are assumed to be + * Java source code files. This program checks to see that the @param + * tags in the documentation comments match with the parameters for + * the associated Java methods. + * <p> + * Any errors found are reported. + * + */ +defineClass("File") + +// Return true if "str" ends with "suffix". +function stringEndsWith(str, suffix) { + return str.substring(str.length - suffix.length) == suffix; +} + +/** + * Perform processing once the end of a documentation comment is seen. + * + * Look for a parameter list following the end of the comment and + * collect the parameters and compare to the @param entries. + * Report any discrepancies. + * @param f the current file + * @param a an array of parameters from @param comments + * @param line the string containing the comment end (in case the + * parameters are on the same line) + */ +function processCommentEnd(f, a, line) { + while (line != null && !line.match(/\(/)) + line = f.readLine(); + while (line != null && !line.match(/\)/)) + line += f.readLine(); + if (line === null) + return; + var m = line.match(/\(([^\)]+)\)/); + var args = m ? m[1].split(",") : []; + if (a.length != args.length) { + print('"' + f.name + + '"; line ' + f.lineNumber + + ' mismatch: had a different number' + + ' of @param entries and parameters.'); + } else { + for (var i=0; i < a.length; i++) { + if (!stringEndsWith(args[i], a[i])) { + print('"' + f.name + + '"; line ' + f.lineNumber + + ' mismatch: had "' + a[i] + + '" and "' + args[i] + '".'); + break; + } + } + } +} + +/** + * Process the given file, looking for mismatched @param lists and + * parameter lists. + * @param f the file to process + */ +function processFile(f) { + var line; + var m; + var i = 0; + var a = []; + outer: + while ((line = f.readLine()) != null) { + if (line.match(/@param/)) { + while (m = line.match(/@param[ ]+([^ ]+)/)) { + a[i++] = m[1]; + line = f.readLine(); + if (line == null) + break outer; + } + } + if (i != 0 && line.match(/\*\//)) { + processCommentEnd(f, a, line); + i = 0; + a = []; + } + } + if (i != 0) { + print('"' + f.name + + '"; line ' + f.lineNumber + + ' missing parameters at end of file.'); + } +} + +// main script: process each file in arguments list + +for (var i=0; i < arguments.length; i++) { + var filename = String(arguments[i]); + print("Checking " + filename + "..."); + var f = new File(filename); + processFile(f); +} +print("done."); + |