[Jython-checkins] SF.net SVN: jython:[6466] trunk/jython/src/org/python/core

[<pj...@us...>]

Revision: 6466
          http://jython.svn.sourceforge.net/jython/?rev=6466&view=rev
Author:   pjenvey
Date:     2009-06-07 23:36:06 +0000 (Sun, 07 Jun 2009)

Log Message:
-----------
javadoc corrections

Modified Paths:
--------------
    trunk/jython/src/org/python/core/Py.java
    trunk/jython/src/org/python/core/PyException.java
    trunk/jython/src/org/python/core/PyFile.java
    trunk/jython/src/org/python/core/PyObject.java

Modified: trunk/jython/src/org/python/core/Py.java
===================================================================
--- trunk/jython/src/org/python/core/Py.java	2009-06-07 23:13:56 UTC (rev 6465)
+++ trunk/jython/src/org/python/core/Py.java	2009-06-07 23:36:06 UTC (rev 6466)
@@ -866,7 +866,7 @@
      * Initializes a default PythonInterpreter and runs the code from
      * {@link PyRunnable#getMain} as __main__
      *
-     * Called by the code generated in {@link Module#addMain()}
+     * Called by the code generated in {@link org.python.compiler.Module#addMain()}
      */
     public static void runMain(PyRunnable main, String[] args) throws Exception {
         runMain(new PyRunnableBootstrap(main), args);
@@ -875,7 +875,7 @@
     /**
      * Initializes a default PythonInterpreter and runs the code loaded from the
      * {@link CodeBootstrap} as __main__ Called by the code generated in
-     * {@link Module#addMain()}
+     * {@link org.python.compiler.Module#addMain()}
      */
     public static void runMain(CodeBootstrap main, String[] args)
             throws Exception {
@@ -1628,18 +1628,6 @@
                                          boolean linenumbers, boolean printResults,
                                          CompilerFlags cflags) {
         return CompilerFacade.compile(node, name, filename, linenumbers, printResults, cflags);
-        /*
-        try {
-            ByteArrayOutputStream ostream = new ByteArrayOutputStream();
-            Module.compile(node, ostream, name, filename, linenumbers, printResults, cflags);
-
-            saveClassFile(name, ostream);
-
-            return BytecodeLoader.makeCode(name, ostream.toByteArray(), filename);
-        } catch (Throwable t) {
-            throw ParserFacade.fixParseError(null, t, filename);
-        }
-        */
     }
 
     public static PyCode compile_flags(mod node, String filename,
@@ -1658,10 +1646,10 @@
     }
 
     /**
-     * Compiles python source code coming from decoded Strings.
+     * Compiles python source code coming from String (raw bytes) data.
      *
-     * DO NOT use this for PyString input. Use
-     * {@link #compile_flags(byte[], String, String, CompilerFlags)} instead.
+     * If the String is properly decoded (from PyUnicode) the PyCF_SOURCE_IS_UTF8 flag
+     * should be specified.
      */
     public static PyCode compile_flags(String data, String filename,
                                          CompileMode kind, CompilerFlags cflags) {

Modified: trunk/jython/src/org/python/core/PyException.java
===================================================================
--- trunk/jython/src/org/python/core/PyException.java	2009-06-07 23:13:56 UTC (rev 6465)
+++ trunk/jython/src/org/python/core/PyException.java	2009-06-07 23:36:06 UTC (rev 6466)
@@ -166,9 +166,9 @@
      * Logic for the raise statement
      *
      * @param type the first arg to raise, a type or an instance
-     * @param value the second arg, the instance of the class or
-     * arguments to its constructor
-     * @param tb a traceback object
+     * @param value the second arg, the instance of the class or arguments to its
+     * constructor
+     * @param traceback a traceback object
      * @return a PyException wrapper
      */
     public static PyException doRaise(PyObject type, PyObject value, PyObject traceback) {

Modified: trunk/jython/src/org/python/core/PyFile.java
===================================================================
--- trunk/jython/src/org/python/core/PyFile.java	2009-06-07 23:13:56 UTC (rev 6465)
+++ trunk/jython/src/org/python/core/PyFile.java	2009-06-07 23:36:06 UTC (rev 6466)
@@ -103,8 +103,8 @@
      * method <code>file</code> doesn't expose this functionality (<code>open</code> does
      * albeit deprecated) as it isn't available to regular Python code. To wrap an
      * InputStream in a file from Python, use
-     * {@link FileUtil#wrap(InputStream, int)}
-     * {@link FileUtil#wrap(InputStream)}
+     * {@link util.FileUtil#wrap(InputStream, int)}
+     * {@link util.FileUtil#wrap(InputStream)}
      */
     public PyFile(InputStream istream, int bufsize) {
         this(istream, "<Java InputStream '" + istream + "' as file>", "r", bufsize, true);
@@ -124,8 +124,8 @@
      * method <code>file</code> doesn't expose this functionality (<code>open</code> does
      * albeit deprecated) as it isn't available to regular Python code. To wrap an
      * OutputStream in a file from Python, use
-     * {@link FileUtil#wrap(OutputStream, int)}
-     * {@link FileUtil#wrap(OutputStream)}
+     * {@link util.FileUtil#wrap(OutputStream, int)}
+     * {@link util.FileUtil#wrap(OutputStream)}
      */
     public PyFile(OutputStream ostream, int bufsize) {
         this(ostream, "<Java OutputStream '" + ostream + "' as file>", "w", bufsize, true);

Modified: trunk/jython/src/org/python/core/PyObject.java
===================================================================
--- trunk/jython/src/org/python/core/PyObject.java	2009-06-07 23:13:56 UTC (rev 6465)
+++ trunk/jython/src/org/python/core/PyObject.java	2009-06-07 23:36:06 UTC (rev 6466)
@@ -904,7 +904,7 @@
      * @return the value corresponding to name
      * @exception Py.AttributeError if the name is not found.
      *
-     * @see #__findattr_ex__(PyString)
+     * @see #__findattr_ex__(String)
      **/
     public final PyObject __getattr__(PyString name) {
         return __getattr__(name.internedString());


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.