Group :: Development/Java
RPM: ritopt
Navigation
Main Changelog Spec Patches Sources Download Gear Bugs and FR Repocop
Patch: ritopt-0.2.1-javadoc.patch
Download
Download
diff -up ./java/gnu/dtools/ritopt/BooleanOption.java.javadoc ./java/gnu/dtools/ritopt/BooleanOption.java
--- ./java/gnu/dtools/ritopt/BooleanOption.java.javadoc 2001-10-13 20:33:35.000000000 +1000
+++ ./java/gnu/dtools/ritopt/BooleanOption.java 2015-10-20 13:53:26.782796539 +1000
@@ -9,10 +9,10 @@ package gnu.dtools.ritopt;
/**
* This class is used for options with boolean values. There are several
- * ways to invoke a boolean option at the command line.<p>
+ * ways to invoke a boolean option at the command line.
*
- * For example, a plus (true) or minus (false) sign directly after the short
- * or long option may be used.<p>
+ * <p>For example, a plus (true) or minus (false) sign directly after the short
+ * or long option may be used.</p>
* <pre>
* myprogram -a+ -b- --longa+ --longb-
* </pre>
@@ -32,10 +32,11 @@ package gnu.dtools.ritopt;
* <li>active
* <li>inactive
* </ul>
- * To invoke an option using assignment form where <value> is the <value> of
- * the option, use the following syntax.<p>
+ * <p>
+ * To invoke an option using assignment form where <value> is the <value> of
+ * the option, use the following syntax.</p>
* <pre>
- * myprogram -a=<keyword> -b <keyword> --longa=<keyword> --longb=<keyword>
+ * myprogram -a=<keyword> -b <keyword> --longa=<keyword> --longb=<keyword>
* </pre>
* Invoking a boolean option without using any of the aforementioned
* keywords and forms will set the option to true by default.
diff -up ./java/gnu/dtools/ritopt/IntOption.java.javadoc ./java/gnu/dtools/ritopt/IntOption.java
--- ./java/gnu/dtools/ritopt/IntOption.java.javadoc 2001-10-14 13:39:24.000000000 +1000
+++ ./java/gnu/dtools/ritopt/IntOption.java 2015-10-20 13:50:17.312799285 +1000
@@ -11,9 +11,6 @@ package gnu.dtools.ritopt;
* This class is used for options with integer values.
*
* <pre>
- *
- * <hr>
- *
* Copyright (C) Damian Ryan Eads, 2001. All Rights Reserved.
*
* ritopt is free software; you can redistribute it and/or modify
diff -up ./java/gnu/dtools/ritopt/OptionArrayable.java.javadoc ./java/gnu/dtools/ritopt/OptionArrayable.java
--- ./java/gnu/dtools/ritopt/OptionArrayable.java.javadoc 2001-10-14 13:39:24.000000000 +1000
+++ ./java/gnu/dtools/ritopt/OptionArrayable.java 2015-10-20 13:50:17.312799285 +1000
@@ -16,7 +16,7 @@ package gnu.dtools.ritopt;
* public void modify(java.lang.String[] value) {
* try {
* int newValues[] = new int[ value.length ];
- * for int( n = 0; n < value.length; n++ ) {
+ * for int( n = 0; n < value.length; n++ ) {
* newValues[ n ] = Integer.parseInt( value[ n ] );
* }
* values[ n ] = newValues;
diff -up ./java/gnu/dtools/ritopt/Option.java.javadoc ./java/gnu/dtools/ritopt/Option.java
--- ./java/gnu/dtools/ritopt/Option.java.javadoc 2001-10-19 15:40:31.000000000 +1000
+++ ./java/gnu/dtools/ritopt/Option.java 2015-10-20 13:50:17.312799285 +1000
@@ -516,7 +516,7 @@ public abstract class Option implements
/**
* Sets whether this option has been invoked.
*
- * @param A boolean indicating whether this option has been invoked.
+ * @param b A boolean indicating whether this option has been invoked.
*/
public void setInvoked( boolean b ) {
diff -up ./java/gnu/dtools/ritopt/Options.java.javadoc ./java/gnu/dtools/ritopt/Options.java
--- ./java/gnu/dtools/ritopt/Options.java.javadoc 2001-10-24 16:41:18.000000000 +1000
+++ ./java/gnu/dtools/ritopt/Options.java 2015-10-20 13:50:17.312799285 +1000
@@ -267,7 +267,7 @@ public class Options implements OptionRe
/**
* Returns the program name displayed in the usage.
*
- * @param The program name.
+ * @return The program name.
*/
public String getUsageProgram() {
@@ -277,7 +277,7 @@ public class Options implements OptionRe
/**
* Returns the version of the program.
*
- * @param The version.
+ * @return The version.
*/
public String getVersion() {
@@ -381,6 +381,7 @@ public class Options implements OptionRe
* Sets the debugging flag.
*
* @param flag The value to set the debugging flag.
+ */
public void setDebugFlag( boolean flag ) {
debugFlag = flag;
@@ -580,7 +581,7 @@ public class Options implements OptionRe
* Splits a string representing command line arguments into several
* strings.
*
- * @param split The string to split.
+ * @param str The string to split.
*
* @return The splitted string.
*/
diff -up ./java/gnu/dtools/ritopt/SimpleProcess.java.javadoc ./java/gnu/dtools/ritopt/SimpleProcess.java
--- ./java/gnu/dtools/ritopt/SimpleProcess.java.javadoc 2001-10-19 15:43:40.000000000 +1000
+++ ./java/gnu/dtools/ritopt/SimpleProcess.java 2015-10-20 13:50:17.312799285 +1000
@@ -19,7 +19,7 @@ import java.io.*;
* <pre>
* class ExecuteProcess {
* public static void main( String args[] ) {
- * if ( args.length > 0 ) {
+ * if ( args.length > 0 ) {
* String processName = args[ 0 ];
* try {
* SimpleProcess process
@@ -114,9 +114,9 @@ public class SimpleProcess extends Proce
* @param process The target process.
* @param processInput The stream that is redirected to the
* processes' standard input.
- * @param processOutput The stream to redirect the processes's
+ * @param yourOutput The stream to redirect the processes's
* standard output.
- * @param processError The stream to redirect the processes's
+ * @param yourError The stream to redirect the processes's
* standard input.
*/
diff -up ./java/gnu/dtools/ritopt/StreamPrinter.java.javadoc ./java/gnu/dtools/ritopt/StreamPrinter.java
--- ./java/gnu/dtools/ritopt/StreamPrinter.java.javadoc 2001-10-19 15:43:40.000000000 +1000
+++ ./java/gnu/dtools/ritopt/StreamPrinter.java 2015-10-20 13:50:17.313799285 +1000
@@ -113,7 +113,7 @@ public class StreamPrinter implements Ru
/**
* Returns whether this StreamPrinter has stopped processing.
*
- * @returns A boolean value.
+ * @return A boolean value.
*/
public boolean isStopped() {
@@ -124,7 +124,7 @@ public class StreamPrinter implements Ru
* Sets whether the output stream should be flushed after each output
* step.
*
- * @param b A boolean value.
+ * @param flush A boolean value.
*/
public void setFlush( boolean flush ) {
diff -up ./java/gnu/dtools/ritopt/StringOption.java.javadoc ./java/gnu/dtools/ritopt/StringOption.java
--- ./java/gnu/dtools/ritopt/StringOption.java.javadoc 2001-10-14 13:39:24.000000000 +1000
+++ ./java/gnu/dtools/ritopt/StringOption.java 2015-10-20 13:50:17.313799285 +1000
@@ -143,7 +143,7 @@ public class StringOption extends Option
/**
* Modify this option using a string value.
*
- * @param value A string value.
+ * @return A string value.
*/
public String getValue() {