Menu
▾
▴
[Jython-checkins] SF.net SVN: jython:[6860] trunk/jython
|
From: <otm...@us...> - 2009-10-15 19:34:42
|
Revision: 6860
http://jython.svn.sourceforge.net/jython/?rev=6860&view=rev
Author: otmarhumbel
Date: 2009-10-15 19:34:31 +0000 (Thu, 15 Oct 2009)
Log Message:
-----------
fixed javadoc warnings
Modified Paths:
--------------
trunk/jython/build.xml
trunk/jython/src/org/python/modules/cPickle.java
trunk/jython/src/org/python/modules/cStringIO.java
trunk/jython/src/org/python/modules/itertools.java
Modified: trunk/jython/build.xml
===================================================================
--- trunk/jython/build.xml 2009-10-15 17:40:22 UTC (rev 6859)
+++ trunk/jython/build.xml 2009-10-15 19:34:31 UTC (rev 6860)
@@ -640,6 +640,7 @@
<target name="javadoc" depends="compile">
<path id="javadoc.classpath">
<pathelement path="${java.class.path}" />
+ <pathelement path="${compile.dir}" />
<path refid="main.classpath" />
</path>
<javadoc sourcepath="${source.dir}"
Modified: trunk/jython/src/org/python/modules/cPickle.java
===================================================================
--- trunk/jython/src/org/python/modules/cPickle.java 2009-10-15 17:40:22 UTC (rev 6859)
+++ trunk/jython/src/org/python/modules/cPickle.java 2009-10-15 19:34:31 UTC (rev 6860)
@@ -548,7 +548,7 @@
* @param file a file-like object, can be a cStringIO.StringIO,
* a PyFile or any python object which implements a
* <i>write</i> method. The data will be written as text.
- * @returns a new Pickler instance.
+ * @return a new Pickler instance.
*/
public static Pickler Pickler(PyObject file) {
return new Pickler(file, 0);
@@ -560,7 +560,7 @@
* a PyFile or any python object which implements a
* <i>write</i> method.
* @param protocol pickle protocol version (0 - text, 1 - pre-2.3 binary, 2 - 2.3)
- * @returns a new Pickler instance.
+ * @return a new Pickler instance.
*/
public static Pickler Pickler(PyObject file, int protocol) {
return new Pickler(file, protocol);
@@ -572,7 +572,7 @@
* @param file a file-like object, can be a cStringIO.StringIO,
* a PyFile or any python object which implements a
* <i>read</i> and <i>readline</i> method.
- * @returns a new Unpickler instance.
+ * @return a new Unpickler instance.
*/
public static Unpickler Unpickler(PyObject file) {
return new Unpickler(file);
@@ -586,7 +586,6 @@
* a PyFile or any python object which implements a
* <i>write</i> method. The data will be written as
* text.
- * @returns a new Unpickler instance.
*/
public static void dump(PyObject object, PyObject file) {
dump(object, file, 0);
@@ -599,7 +598,6 @@
* a PyFile or any python object which implements a
* <i>write</i> method.
* @param protocol pickle protocol version (0 - text, 1 - pre-2.3 binary, 2 - 2.3)
- * @returns a new Unpickler instance.
*/
public static void dump(PyObject object, PyObject file, int protocol) {
new Pickler(file, protocol).dump(object);
@@ -609,7 +607,7 @@
/**
* Shorthand function which pickles and returns the string representation.
* @param object a data object which should be pickled.
- * @returns a string representing the pickled object.
+ * @return a string representing the pickled object.
*/
public static PyString dumps(PyObject object) {
return dumps(object, 0);
@@ -620,7 +618,7 @@
* Shorthand function which pickles and returns the string representation.
* @param object a data object which should be pickled.
* @param protocol pickle protocol version (0 - text, 1 - pre-2.3 binary, 2 - 2.3)
- * @returns a string representing the pickled object.
+ * @return a string representing the pickled object.
*/
public static PyString dumps(PyObject object, int protocol) {
cStringIO.StringIO file = cStringIO.StringIO();
@@ -635,7 +633,7 @@
* @param file a file-like object, can be a cStringIO.StringIO,
* a PyFile or any python object which implements a
* <i>read</i> and <i>readline</i> method.
- * @returns a new object.
+ * @return a new object.
*/
public static Object load(PyObject file) {
return new Unpickler(file).load();
@@ -647,7 +645,7 @@
* returns the new object.
* @param str a strings which must contain a pickled object
* representation.
- * @returns a new object.
+ * @return a new object.
*/
public static Object loads(PyObject str) {
cStringIO.StringIO file = cStringIO.StringIO(str.toString());
Modified: trunk/jython/src/org/python/modules/cStringIO.java
===================================================================
--- trunk/jython/src/org/python/modules/cStringIO.java 2009-10-15 17:40:22 UTC (rev 6859)
+++ trunk/jython/src/org/python/modules/cStringIO.java 2009-10-15 19:34:31 UTC (rev 6860)
@@ -26,10 +26,6 @@
* @version cStringIO.java,v 1.10 1999/05/20 18:03:20 fb Exp
*/
public class cStringIO {
- /**
- * Create an empty StringIO object
- * @return a new StringIO object.
- */
// would be nicer if we directly imported from os, but crazy to do so
// since in python code itself
@@ -48,7 +44,7 @@
/**
* Create a StringIO object, initialized by the value.
- * @param buf The initial value.
+ * @param buffer The initial value.
* @return a new StringIO object.
*/
public static StringIO StringIO(String buffer) {
@@ -134,8 +130,11 @@
/**
* Position the file pointer to the position in the .
- * @param pos the position in the file.
- * @param mode; 0=from the start, 1=relative, 2=from the end.
+ *
+ * @param pos
+ * the position in the file.
+ * @param mode
+ * 0=from the start, 1=relative, 2=from the end.
*/
public synchronized void seek(long pos, int mode) {
_complain_ifclosed();
@@ -162,7 +161,7 @@
/**
* Return the file position.
- * @returns the position in the file.
+ * @return the position in the file.
*/
public synchronized int tell() {
_complain_ifclosed();
@@ -174,7 +173,7 @@
/**
* Read all data until EOF is reached.
* An empty string is returned when EOF is encountered immediately.
- * @returns A string containing the data.
+ * @return A string containing the data.
*/
public PyString read() {
return read(-1);
@@ -187,7 +186,7 @@
* reached. An empty string is returned when EOF is encountered
* immediately.
* @param size the number of characters to read.
- * @returns A string containing the data read.
+ * @return A string containing the data read.
*/
public synchronized PyString read(long size) {
@@ -212,7 +211,7 @@
* is kept in the string (but may be absent when a file ends with
* an incomplete line).
* An empty string is returned when EOF is hit immediately.
- * @returns data from the file up to and including the newline.
+ * @return data from the file up to and including the newline.
*/
public PyString readline() {
return readline(-1);
@@ -226,7 +225,7 @@
* If the size argument is non-negative, it is a maximum byte count
* (including the trailing newline) and an incomplete line may be
* returned.
- * @returns data from the file up to and including the newline.
+ * @return data from the file up to and including the newline.
*/
public synchronized PyString readline(long size) {
_complain_ifclosed();
@@ -317,7 +316,7 @@
/**
* Write a string to the file.
- * @param s The data to write.
+ * @param obj The data to write.
*/
public void write(PyObject obj) {
write(obj.toString());
Modified: trunk/jython/src/org/python/modules/itertools.java
===================================================================
--- trunk/jython/src/org/python/modules/itertools.java 2009-10-15 17:40:22 UTC (rev 6859)
+++ trunk/jython/src/org/python/modules/itertools.java 2009-10-15 19:34:31 UTC (rev 6860)
@@ -354,16 +354,14 @@
}
/**
- * @see islice(PyObject PyObject iterable, PyObject startObj, PyObject
- * stopObj, PyObject stepObj) startObj defaults to 0 and stepObj to 1
+ * @see #islice(PyObject, PyObject, PyObject, PyObject) startObj defaults to 0 and stepObj to 1
*/
public static PyIterator islice(PyObject iterable, PyObject stopObj) {
return islice(iterable, new PyInteger(0), stopObj, new PyInteger(1));
}
/**
- * @see islice(PyObject PyObject iterable, PyObject startObj, PyObject stopObj, PyObject
- * stepObj) stepObj defaults to 1
+ * @see #islice(PyObject, PyObject, PyObject, PyObject) stepObj defaults to 1
*/
public static PyIterator islice(PyObject iterable, PyObject start,
PyObject stopObj) {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
