Revision: 5595
http://jnode.svn.sourceforge.net/jnode/?rev=5595&view=rev
Author: crawley
Date: 2009-07-07 10:24:20 +0000 (Tue, 07 Jul 2009)
Log Message:
-----------
Javadoc fixes
Modified Paths:
--------------
trunk/cli/src/commands/org/jnode/command/archive/ArchiveCommand.java
trunk/cli/src/commands/org/jnode/command/common/BasenameCommand.java
trunk/cli/src/commands/org/jnode/command/common/DirnameCommand.java
trunk/cli/src/commands/org/jnode/command/common/HistoryCommand.java
trunk/cli/src/commands/org/jnode/command/file/DeleteCommand.java
trunk/cli/src/commands/org/jnode/command/file/WcCommand.java
Modified: trunk/cli/src/commands/org/jnode/command/archive/ArchiveCommand.java
===================================================================
--- trunk/cli/src/commands/org/jnode/command/archive/ArchiveCommand.java
2009-07-06 15:23:39 UTC (rev 5594)
+++ trunk/cli/src/commands/org/jnode/command/archive/ArchiveCommand.java
2009-07-07 10:24:20 UTC (rev 5595)
@@ -125,11 +125,10 @@
* This is most usefull for applying a stream filter that reads data from
a source
* and pipes the contents to an output stream.
*
- * @param InputStream stream to read from
- * @param OutputStream stream to write to
- * @param int size of buffer to use.
+ * @param in stream to read from
+ * @param out stream to write to
*/
- protected void processStream(InputStream in , OutputStream out) throws
IOException {
+ protected void processStream(InputStream in, OutputStream out) throws
IOException {
int len;
if (buffer == null) buffer = new byte[4096];
while ((len = in.read(buffer)) > 0) {
@@ -143,13 +142,13 @@
* If there is a problem opening the stream, the exception is caught and
an error message
* is displayed.
*
- * @param File the file to open the stream on
- * @param boolean if the file exists, delete it first
- * @param boolean if delete is true, this forces the deletion without
prompting the user
+ * @param file the file to open the stream on
+ * @param delete if the file exists, delete it first
+ * @param forced if true, this forces the deletion without prompting the
user
* @return an OutputStream on the file, or null if there was a problem.
null could also be
* returned if the delete option was chosen and the user said no
to overwriting.
*/
- protected OutputStream openFileWrite(File file , boolean delete , boolean
forced) {
+ protected OutputStream openFileWrite(File file, boolean delete, boolean
forced) {
try {
boolean createNew = true;
if (file == null) {
@@ -190,7 +189,7 @@
* If there is a problem opening the stream, the IOException is caught,
and an
* error message displayed to the console.
*
- * @param the file to open the stream on
+ * @param file the file to open the stream on
* @return the InputStream or null if there was a problem.
*/
protected InputStream openFileRead(File file) {
@@ -238,13 +237,14 @@
* FIXME This is unsafe as it will trigger an endless loop if stdin
* is not the terminal.
*
- * @param String the question to ask the user
+ * @param s the question to ask the user
+ * @param defaultY if {#code true}, the default answer is yes, otherwise
no.
* @return true if the user said yes, false if the user said no
*/
protected boolean prompt_yn(String s, boolean defaultY) {
int choice;
// put a cap on the looping to prevent non-terminal stdin
- // from an infinte loop
+ // from an infinite loop
for (int i = 0; i < 10; i++) {
stdoutWriter.print(s);
try {
Modified: trunk/cli/src/commands/org/jnode/command/common/BasenameCommand.java
===================================================================
--- trunk/cli/src/commands/org/jnode/command/common/BasenameCommand.java
2009-07-06 15:23:39 UTC (rev 5594)
+++ trunk/cli/src/commands/org/jnode/command/common/BasenameCommand.java
2009-07-07 10:24:20 UTC (rev 5595)
@@ -25,9 +25,9 @@
import org.jnode.shell.syntax.StringArgument;
/**
- * Unix `basename` command.
+ * Command to get the filename part of a pathname.
*
- * @see {...@link
http://www.opengroup.org/onlinepubs/000095399/utilities/basename.html}
+ * @see <a
href="http://www.opengroup.org/onlinepubs/000095399/utilities/basename.html";>POSIX
"basename" command</a>
* @author chris boertien
*/
public class BasenameCommand extends AbstractCommand {
Modified: trunk/cli/src/commands/org/jnode/command/common/DirnameCommand.java
===================================================================
--- trunk/cli/src/commands/org/jnode/command/common/DirnameCommand.java
2009-07-06 15:23:39 UTC (rev 5594)
+++ trunk/cli/src/commands/org/jnode/command/common/DirnameCommand.java
2009-07-07 10:24:20 UTC (rev 5595)
@@ -25,8 +25,8 @@
import org.jnode.shell.syntax.StringArgument;
/**
- * Unix `dirname` command
- * @see http://www.opengroup.org/onlinepubs/000095399/utilities/dirname.html
+ * Command to get the directory part of a pathname.
+ * @see <a
href="http://www.opengroup.org/onlinepubs/000095399/utilities/dirname.html";>POSIX
"dirname" command</a>
* @author chris boertien
*/
public class DirnameCommand extends AbstractCommand {
Modified: trunk/cli/src/commands/org/jnode/command/common/HistoryCommand.java
===================================================================
--- trunk/cli/src/commands/org/jnode/command/common/HistoryCommand.java
2009-07-06 15:23:39 UTC (rev 5594)
+++ trunk/cli/src/commands/org/jnode/command/common/HistoryCommand.java
2009-07-07 10:24:20 UTC (rev 5595)
@@ -40,7 +40,7 @@
public class HistoryCommand extends AbstractCommand {
private static final String help_index = "A history list index";
- private static final String help_prefix = "A histor list prefix (>= 0)";
+ private static final String help_prefix = "A history list prefix (>= 0)";
private static final String help_test = "If set, don't try to execute the
history command";
private static final String help_super = "Command history list or execute";
private static final String err_not_found_1 = "History command #%d not
found%n";
Modified: trunk/cli/src/commands/org/jnode/command/file/DeleteCommand.java
===================================================================
--- trunk/cli/src/commands/org/jnode/command/file/DeleteCommand.java
2009-07-06 15:23:39 UTC (rev 5594)
+++ trunk/cli/src/commands/org/jnode/command/file/DeleteCommand.java
2009-07-07 10:24:20 UTC (rev 5595)
@@ -43,7 +43,7 @@
* @author Martin Husted Hartvig (hagar at jnode.org)
* @author craw...@jnode.org
* @author chris boertien
- * @see {...@link
http://www.opengroup.org/onlinepubs/009695399/utilities/rm.html}
+ * @see <a
href="http://www.opengroup.org/onlinepubs/009695399/utilities/rm.html";>POSIX
"rm" command</a>
*/
public class DeleteCommand extends AbstractCommand {
Modified: trunk/cli/src/commands/org/jnode/command/file/WcCommand.java
===================================================================
--- trunk/cli/src/commands/org/jnode/command/file/WcCommand.java
2009-07-06 15:23:39 UTC (rev 5594)
+++ trunk/cli/src/commands/org/jnode/command/file/WcCommand.java
2009-07-07 10:24:20 UTC (rev 5595)
@@ -35,9 +35,9 @@
import org.jnode.shell.syntax.FlagArgument;
/**
- * Word, line and byte or character count command.
+ * Count the words, lines and bytes or characters in a file or stream.
*
- * @see {...@link http://www.opengroup.org/onlinepubs/7990989775/xcu/wc.html}
+ * @see <a
href="http://www.opengroup.org/onlinepubs/7990989775/xcu/wc.html";>POSIX "wc"
command</a>
* @author cy6erGn0m
* @author Yves Galante
*/
@@ -45,7 +45,7 @@
private static final String STR_SUPER = "Print newline, word, and byte
counts for each file.";
private static final String STR_TOTAL = "total";
- private static final String STR_ERROR_DIR = "File is a directoy : ";
+ private static final String STR_ERROR_DIR = "File is a directory : ";
private static final String STR_ERROR_NOT_EXIST = "File not exist : ";
private static final String STR_ERROR_CANT_READ = "File can't be read : ";
private static final String STR_ERROR_IO_EX = "IO error";
@@ -161,10 +161,8 @@
/**
* Prints results.
*
- * @param printWriter
- * the print writer
- * @param listWc
- * the world count stream list
+ * @param printWriter the print writer
+ * @param listWc the world count stream list
*/
private void printResults(PrintWriter printWriter, List<WcStream> listWc) {
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Enter the BlackBerry Developer Challenge
This is your chance to win up to $100,000 in prizes! For a limited time,
vendors submitting new applications to BlackBerry App World(TM) will have
the opportunity to enter the BlackBerry Developer Challenge. See full prize
details at: http://p.sf.net/sfu/blackberry
_______________________________________________
Jnode-svn-commits mailing list
Jnode-svn-commits@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/jnode-svn-commits
