docs/genshelldoc.js

changeset 0
b1a7da25b547
child 952
6d5471a497fb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/genshelldoc.js	Wed Apr 27 01:36:41 2016 +0800
     1.3 @@ -0,0 +1,90 @@
     1.4 +/*
     1.5 + * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + * 
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.
    1.11 + * 
    1.12 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.13 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.14 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.15 + * version 2 for more details (a copy is included in the LICENSE file that
    1.16 + * accompanied this code).
    1.17 + * 
    1.18 + * You should have received a copy of the GNU General Public License version
    1.19 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.20 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.21 + * 
    1.22 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.23 + * or visit www.oracle.com if you need additional information or have any
    1.24 + * questions.
    1.25 + */
    1.26 +
    1.27 +/**
    1.28 + * Generate HTML documentation for shell tool. Re-run this tool to regenerate
    1.29 + * html doc when you change options.
    1.30 + *
    1.31 + * Usage:
    1.32 + *
    1.33 + *     jjs -scripting genshelldoc.js > shell.html
    1.34 + */
    1.35 +
    1.36 +var Options = Packages.jdk.nashorn.internal.runtime.options.Options;
    1.37 +var title = "Nashorn command line shell tool";
    1.38 +
    1.39 +print(<<PREFIX
    1.40 +<html>
    1.41 +<head>
    1.42 +<title>
    1.43 +${title}
    1.44 +</title>
    1.45 +</head>
    1.46 +<body>
    1.47 +<h1>Usage</h1>
    1.48 +<p>
    1.49 +<code>
    1.50 +<b>jjs &lt;options&gt; &lt;script-files&gt; [ -- &lt;script-arguments&gt; ]</b>
    1.51 +</code>
    1.52 +</p>
    1.53 +
    1.54 +<h1>${title} options</h1>
    1.55 +
    1.56 +<table border="0">
    1.57 +<tr>
    1.58 +<th>name</th>
    1.59 +<th>type</th>
    1.60 +<th>default</th>
    1.61 +<th>description</th>
    1.62 +</tr>
    1.63 +PREFIX);
    1.64 +
    1.65 +for each (opt in Options.validOptions) {
    1.66 +
    1.67 +var isTimezone = (opt.type == "timezone");   
    1.68 +var defValue = opt.defaultValue;
    1.69 +if (defValue == null) {
    1.70 +    defValue = "&lt;none&gt;";
    1.71 +}
    1.72 +
    1.73 +if (isTimezone) {
    1.74 +    // don't output current user's timezone
    1.75 +    defValue = "&lt;default-timezone&gt;"
    1.76 +}
    1.77 +
    1.78 +print(<<ROW
    1.79 +  <tr>
    1.80 +  <td><b>${opt.name} ${opt.shortName == null? "" : opt.shortName}</b></td>
    1.81 +  <td>${opt.type}</td>
    1.82 +  <td>${defValue}</td>
    1.83 +  <td>${opt.description}</td>
    1.84 +  </tr>
    1.85 +ROW);
    1.86 +
    1.87 +}
    1.88 +
    1.89 +print(<<SUFFIX
    1.90 +</table>
    1.91 +</body>
    1.92 +</html>
    1.93 +SUFFIX);

mercurial