Fix kotlinc command line usage information

Fix spelling, case, minor grammar
2014-06-23 10:05:02 +04:00
parent d963ff31ae
commit f51e172570
8 changed files with 122 additions and 116 deletions
@@ -25,15 +25,20 @@ import static org.jetbrains.jet.cli.common.arguments.CommonArgumentConstants.SUP
 public abstract class CommonCompilerArguments {
    @Argument(value = "tags", description = "Demarcate each compilation message (error, warning, etc) with an open and close tag")
    public boolean tags;
+
    @Argument(value = "verbose", description = "Enable verbose logging output")
    public boolean verbose;
+
    @Argument(value = "version", description = "Display compiler version")
    public boolean version;
-    @Argument(value = "help", alias = "h", description = "Show help")
+
+    @Argument(value = "help", alias = "h", description = "Print a synopsis of standard options")
    public boolean help;
+
    @Argument(value = "suppress", description = "Suppress compiler messages by severity (" + SUPPRESS_WARNINGS + ")")
    public String suppress;
-    @Argument(value = "printArgs", description = "Print commandline arguments")
+
+    @Argument(value = "printArgs", description = "Print command line arguments")
    public boolean printArgs;

    public List<String> freeArgs = new SmartList<String>();
@@ -38,7 +38,7 @@ public class K2JSCompilerArguments extends CommonCompilerArguments {
    @Argument(value = "sourcemap", description = "Generate SourceMap")
    public boolean sourcemap;

-    @Argument(value = "target", description = "Generate js files for specific ECMA version (now support only ECMA 5)")
+    @Argument(value = "target", description = "Generate JS files for specific ECMA version (only ECMA 5 is supported)")
    public String target;

    @Nullable
@@ -46,7 +46,7 @@ public class K2JSCompilerArguments extends CommonCompilerArguments {
                                            "' or '" + NO_CALL + "', default '" + CALL + "' (main function will be auto detected)")
    public String main;

-    @Argument(value = "outputPrefix", description = "Path to file which will be added to the begin of output file")
+    @Argument(value = "outputPrefix", description = "Path to file which will be added to the beginning of output file")
    public String outputPrefix;

    @Argument(value = "outputPostfix", description = "Path to file which will be added to the end of output file")
@@ -15,57 +15,58 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
+
 package org.jetbrains.jet.cli.common.arguments;

 import com.sampullara.cli.Argument;

 /**
- * Command line arguments for the {@link K2JVMCompiler}
+ * Command line arguments for K2JVMCompiler
 */
@SuppressWarnings("UnusedDeclaration")
 public class K2JVMCompilerArguments extends CommonCompilerArguments {
-    @Argument(value = "jar", description = "jar file name")
-    public String jar;
-
-    @Argument(value = "src", description = "source file or directory (allows many paths separated by the system path separator)")
+    @Argument(value = "src", description = "Source file or directory (allows many paths separated by the system path separator)")
    public String src;

-    @Argument(value = "classpath", description = "classpath to use when compiling")
-    public String classpath;
+    @Argument(value = "jar", description = "Resulting .jar file path")
+    public String jar;

-    @Argument(value = "annotations", description = "paths to external annotations")
-    public String annotations;
-
-    @Argument(value = "includeRuntime", description = "include Kotlin runtime in to resulting jar")
-    public boolean includeRuntime;
-
-    @Argument(value = "noJdk", description = "don't include Java runtime into classpath")
-    public boolean noJdk;
-
-    @Argument(value = "noStdlib", description = "don't include Kotlin runtime into classpath")
-    public boolean noStdlib;
-
-    @Argument(value = "noJdkAnnotations", description = "don't include JDK external annotations into classpath")
-    public boolean noJdkAnnotations;
-
-    @Argument(value = "notNullAssertions", description = "generate not-null assertion after each invocation of method returning not-null")
-    public boolean notNullAssertions;
-
-    @Argument(value = "notNullParamAssertions", description = "generate not-null assertions on parameters of methods accessible from Java")
-    public boolean notNullParamAssertions;
-
-    @Argument(value = "output", description = "output directory")
+    @Argument(value = "output", description = "Output directory path for .class files")
    public String outputDir;

-    @Argument(value = "module", description = "module to compile")
+    @Argument(value = "classpath", description = "Paths where to find user class files")
+    public String classpath;
+
+    @Argument(value = "annotations", description = "Paths to external annotations")
+    public String annotations;
+
+    @Argument(value = "includeRuntime", description = "Include Kotlin runtime in to resulting .jar")
+    public boolean includeRuntime;
+
+    @Argument(value = "noJdk", description = "Don't include Java runtime into classpath")
+    public boolean noJdk;
+
+    @Argument(value = "noStdlib", description = "Don't include Kotlin runtime into classpath")
+    public boolean noStdlib;
+
+    @Argument(value = "noJdkAnnotations", description = "Don't include JDK external annotations into classpath")
+    public boolean noJdkAnnotations;
+
+    @Argument(value = "notNullAssertions", description = "Generate not-null assertion after each invocation of method returning not-null")
+    public boolean notNullAssertions;
+
+    @Argument(value = "notNullParamAssertions", description = "Generate not-null assertions on parameters of methods accessible from Java")
+    public boolean notNullParamAssertions;
+
+    @Argument(value = "module", description = "Path to the module file to compile")
    public String module;

-    @Argument(value = "script", description = "evaluate script")
+    @Argument(value = "script", description = "Evaluate the script file")
    public boolean script;

    @Argument(value = "kotlinHome", description = "Path to Kotlin compiler home directory, used for annotations and runtime libraries discovery")
    public String kotlinHome;

-    @Argument(value = "inline", description = "Inlining mode: on/off or true/false (default is on)")
+    @Argument(value = "inline", description = "Inlining mode: on/off (default is on)")
    public String inline;
 }