SF.net SVN: jython:[7110] trunk/jython/src/org/python/core/imp.java

Revision: 7110
          http://jython.svn.sourceforge.net/jython/?rev=7110&view=rev
Author:   zyasoft
Date:     2010-09-04 02:43:03 +0000 (Sat, 04 Sep 2010)

Log Message:
-----------
Doc cleanup

Modified Paths:
--------------
    trunk/jython/src/org/python/core/imp.java

Modified: trunk/jython/src/org/python/core/imp.java
===================================================================
--- trunk/jython/src/org/python/core/imp.java	2010-08-28 03:52:43 UTC (rev 7109)
+++ trunk/jython/src/org/python/core/imp.java	2010-09-04 02:43:03 UTC (rev 7110)
@@ -48,22 +48,24 @@
     }
     
     /**
-     * <p>
-     * Selects the parent class loader for Jython, used for dinamically load classes and resources 
+     * Selects the parent class loader for Jython, to be used for
+     * dynamically loaded classes and resources.  Chooses between the
+     * current and context classloader based on the following
+     * criteria:
+     *
+     * <ul>
+     * <li>If both are the same classloader, return that classloader.
+     * <li>If either is null, then the non-null one is selected.
+     * <li>If both are not null, and a parent/child relationship can
+     * be determined, then the child is selected.
+     * <li>If both are not null and not on a parent/child
+     * relationship, then the current class loader is returned (since
+     * it is likely for the context class loader to <b>not</b> see the
+     * Jython classes)
+     * </ul>
      * 
-     * <p>
-     * The current implementation chooses between the current and context 
-     * classloader based on the following criteria:<ul>
-     * 
-     * <li>If both are the same, that one is returned.
-     * <li>If either is null, the non-null one is selected.
-     * <li>If both are not null, and a parent/child relationship can be determined, 
-     * the child is selected. 
-     * <li>If both are not null and not on a parent/child relationship, the
-     * current class loader is returned (since it is likely for the
-     * context class loader to <b>not</b> see the Jython classes)
-     * 
-     * @return the parent class loader for Jython or null if both the current and context classloaders are null;
+     * @return the parent class loader for Jython or null if both the
+     * current and context classloaders are null.
      */
     public static ClassLoader getParentClassLoader() {
     	ClassLoader current = imp.class.getClassLoader();
@@ -252,14 +254,15 @@
     /**
      * Stores the bytes in compiledSource in compiledFilename.
      *
-     * If compiledFilename is null it's set to the results of
-     * makeCompiledFilename(sourcefileName)
+     * If compiledFilename is null, it's set to the results of
+     * makeCompiledFilename(sourcefileName).
      *
-     * If sourceFilename is null or set to UNKNOWN_SOURCEFILE null is returned
+     * If sourceFilename is null or set to UNKNOWN_SOURCEFILE, then
+     * null is returned.
      *
-     * @return the compiledFilename eventually used or null if a
-     *         compiledFilename couldn't be determined of if an error was thrown
-     *         while writing to the cache file.
+     * @return the compiledFilename eventually used; or null if a
+     *         compiledFilename couldn't be determined or if an error
+     *         was thrown while writing to the cache file.
      */
     public static String cacheCompiledSource(String sourceFilename,
                                               String compiledFilename,


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

------------------------------------------------------------------------------
This SF.net Dev2Dev email is sponsored by:

Show off your parallel programming skills.
Enter the Intel(R) Threading Challenge 2010.
http://p.sf.net/sfu/intel-thread-sfd