This is the mail archive of the
frysk@sources.redhat.com
mailing list for the frysk project.
javadoc update
- From: Tom Tromey <tromey at redhat dot com>
- To: Frysk Hackers <frysk at sourceware dot org>
- Date: 23 Aug 2006 15:14:51 -0600
- Subject: javadoc update
- Reply-to: tromey at redhat dot com
Here's a patch to fix some javadoc.
I decapitalized 'FRYSK' in proc's package.html since it looks weird in
all caps.
I fixed a link in Syscall and wrote javadoc for the remaining public
methods.
Tom
Index: frysk/proc/ChangeLog
from Tom Tromey <tromey@redhat.com>
* Syscall.java: Updated javadoc.
* package.html: Don't capitalize 'frysk'.
Index: frysk/proc/Syscall.java
===================================================================
RCS file: /cvs/frysk/frysk-core/frysk/proc/Syscall.java,v
retrieving revision 1.10
diff -u -r1.10 Syscall.java
--- frysk/proc/Syscall.java 22 Aug 2006 00:44:00 -0000 1.10
+++ frysk/proc/Syscall.java 23 Aug 2006 21:14:41 -0000
@@ -41,9 +41,9 @@
import inua.util.PrintWriter;
/**
- * A class that holds static Syscall info. It is used
- * in combination with @link frysk.proc.SyscallEventInfo and
- * the task to get information about a particular system call event.
+ * A class that holds static information about a system call. It is
+ * used in combination with {@link SyscallEventInfo} and the
+ * task to get information about a particular system call event.
*/
public class Syscall
{
@@ -84,12 +84,14 @@
{
this ("<" + number + ">", number, 0, "i:");
}
-
+
+ /** Return the name of the system call. */
public String getName()
{
return name;
}
+ /** Return the system call's number. */
public int getNumber()
{
return number;
@@ -111,7 +113,15 @@
writer.print (x);
}
}
-
+
+ /**
+ * Print a textual representation of a system call.
+ * @param writer where to print the representation
+ * @param task the task which supplies information about the
+ * arguments
+ * @param syscall the system call event info
+ * @return writer
+ */
public PrintWriter printCall (PrintWriter writer,
frysk.proc.Task task,
SyscallEventInfo syscall)
@@ -152,6 +162,15 @@
return writer;
}
+ /**
+ * Print a textual representation of the return result of a system
+ * call.
+ * @param writer where to print the representation
+ * @param task the task which supplies information about the
+ * return value
+ * @param syscall the system call event info
+ * @return writer
+ */
public PrintWriter printReturn (PrintWriter writer,
frysk.proc.Task task,
SyscallEventInfo syscallEventInfo)
@@ -193,8 +212,14 @@
return writer;
}
- // XXX: Eventually this will be moved down to Linux, or even
- // further.
+ /**
+ * Given a system call's number, this will return the corresponding
+ * Syscall object. Note that system call numbers are platform
+ * dependent.
+ * XXX: Eventually this will be moved down to Linux, or even
+ * further.
+ * @param num the number of the system call
+ */
public static Syscall syscallByNum (int num)
{
if(num >= syscallList.length || num < 0){
Index: frysk/proc/package.html
===================================================================
RCS file: /cvs/frysk/frysk-core/frysk/proc/package.html,v
retrieving revision 1.2
diff -u -r1.2 package.html
--- frysk/proc/package.html 19 Sep 2005 00:05:23 -0000 1.2
+++ frysk/proc/package.html 23 Aug 2006 21:14:41 -0000
@@ -1,7 +1,7 @@
<html>
<body>
-This package implements FRYSK's process model of the target system.
+This package implements frysk's process model of the target system.
<h2>Overview</h2>