You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by mm...@locus.apache.org on 2000/12/14 17:57:36 UTC
cvs commit: xml-xalan/java/src/org/apache/xalan/extensions ExtensionHandler.java ExtensionHandlerGeneral.java ExtensionHandlerJava.java ExtensionsTable.java XSLProcessorContext.java
mmidy 00/12/14 08:57:35
Modified: java/src/org/apache/xalan/extensions ExtensionHandler.java
ExtensionHandlerGeneral.java
ExtensionHandlerJava.java ExtensionsTable.java
XSLProcessorContext.java
Log:
Javadoc updates
Revision Changes Path
1.10 +6 -4 xml-xalan/java/src/org/apache/xalan/extensions/ExtensionHandler.java
Index: ExtensionHandler.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/extensions/ExtensionHandler.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ExtensionHandler.java 2000/12/07 17:57:59 1.9
+++ ExtensionHandler.java 2000/12/14 16:57:25 1.10
@@ -112,6 +112,8 @@
* Replacement for Class.forName. This method loads a class using the context class loader
* if we're running under Java2 or higher. If we're running under Java1, this
* method just uses Class.forName to load the class.
+ *
+ * @param className Name of the class to load
*/
static Class getClassForName(String className)
throws ClassNotFoundException
@@ -166,7 +168,7 @@
* Tests whether a certain element name is known within this namespace.
* @param function name of the function being tested
*
- * NEEDSDOC @param element
+ * @param element Name of element to check
* @return true if its known, false if not.
*/
public abstract boolean isElementAvailable(String element);
@@ -176,8 +178,8 @@
*
* @param funcName Function name.
* @param args The arguments of the function call.
- * NEEDSDOC @param methodKey
- * NEEDSDOC @param exprContext
+ * @param methodKey A key that uniquely identifies this class and method call.
+ * @param exprContext The context in which this expression is being executed.
*
* @return the return value of the function evaluation.
*
@@ -199,7 +201,7 @@
* @param sourceTree The root of the source tree (but don't assume
* it's a Document).
* @param sourceNode The current context node.
- * NEEDSDOC @param methodKey
+ * @param methodKey A key that uniquely identifies this class and method call.
*
* @exception XSLProcessorException thrown if something goes wrong
* while running the extension handler.
1.9 +28 -28 xml-xalan/java/src/org/apache/xalan/extensions/ExtensionHandlerGeneral.java
Index: ExtensionHandlerGeneral.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/extensions/ExtensionHandlerGeneral.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ExtensionHandlerGeneral.java 2000/11/23 04:57:17 1.8
+++ ExtensionHandlerGeneral.java 2000/12/14 16:57:25 1.9
@@ -88,48 +88,48 @@
public class ExtensionHandlerGeneral extends ExtensionHandler
{
- /** NEEDSDOC Field m_scriptSrc */
- private String m_scriptSrc; // script source to run (if any)
+ /** script source to run (if any) */
+ private String m_scriptSrc;
- /** NEEDSDOC Field m_scriptSrcURL */
- private String m_scriptSrcURL; // URL of source of script (if any)
+ /** URL of source of script (if any) */
+ private String m_scriptSrcURL;
- /** NEEDSDOC Field m_functions */
- private Hashtable m_functions = new Hashtable(); // functions of namespace
+ /** functions of namespace */
+ private Hashtable m_functions = new Hashtable();
- /** NEEDSDOC Field m_elements */
- private Hashtable m_elements = new Hashtable(); // elements of namespace
+ /** elements of namespace */
+ private Hashtable m_elements = new Hashtable();
// BSF objects used to invoke BSF by reflection. Do not import the BSF classes
// since we don't want a compile dependency on BSF.
- /** NEEDSDOC Field m_mgr */
- private Object m_mgr; // BSF manager used to run scripts
+ /** Instance of Manager class */
+ private Object m_mgr; //
- /** NEEDSDOC Field m_engine */
- private Object m_engine; // BSF engine used to run scripts
+ /** BSF manager used to run scripts */
+ private Object m_engine;
// static fields
- /** NEEDSDOC Field BSF_MANAGER */
+ /** BSFManager package name */
private static final String BSF_MANAGER = "com.ibm.bsf.BSFManager";
- /** NEEDSDOC Field managerClass */
+ /** Manager class */
private static Class managerClass;
- /** NEEDSDOC Field mgrLoadScriptingEngine */
+ /** Manager load scripting engine */
private static Method mgrLoadScriptingEngine;
- /** NEEDSDOC Field BSF_ENGINE */
+ /** BSFEngine package name */
private static final String BSF_ENGINE = "com.ibm.bsf.BSFEngine";
- /** NEEDSDOC Field engineExec */
- private static Method engineExec; // Engine call to "compile" scripts
+ /** Engine call to "compile" scripts */
+ private static Method engineExec;
- /** NEEDSDOC Field engineCall */
- private static Method engineCall; // Engine call to invoke scripts
+ /** Engine call to invoke scripts */
+ private static Method engineCall;
- /** NEEDSDOC Field NEG1INT */
+ /** Negative one integer */
private static final Integer NEG1INT = new Integer(-1);
static
@@ -167,14 +167,14 @@
* needed.
*
* @param namespaceUri the extension namespace URI that I'm implementing
- * NEEDSDOC @param elemNames
+ * @param elemNames Vector of element names
* @param funcNames string containing list of functions of extension NS
* @param lang language of code implementing the extension
* @param srcURL value of src attribute (if any) - treated as a URL
* or a classname depending on the value of lang. If
* srcURL is not null, then scriptSrc is ignored.
- * NEEDSDOC @param scriptLang
- * NEEDSDOC @param scriptSrcURL
+ * @param scriptLang Scripting language of implementation
+ * @param scriptSrcURL URL of source script
* @param scriptSrc the actual script code (if any)
*
* @throws TransformerException
@@ -256,7 +256,7 @@
* Tests whether a certain element name is known within this namespace.
* @param function name of the function being tested
*
- * NEEDSDOC @param element
+ * @param element name of the element being tested
* @return true if its known, false if not.
*/
public boolean isElementAvailable(String element)
@@ -269,8 +269,8 @@
*
* @param funcName Function name.
* @param args The arguments of the function call.
- * NEEDSDOC @param methodKey
- * NEEDSDOC @param exprContext
+ * @param methodKey A key that uniquely identifies this class and method call.
+ * @param exprContext The context in which this expression is being executed.
*
* @return the return value of the function evaluation.
*
@@ -340,7 +340,7 @@
* @param sourceTree The root of the source tree (but don't assume
* it's a Document).
* @param sourceNode The current context node.
- * NEEDSDOC @param methodKey
+ * @param methodKey A key that uniquely identifies this class and method call.
*
* @exception XSLProcessorException thrown if something goes wrong
* while running the extension handler.
1.3 +7 -7 xml-xalan/java/src/org/apache/xalan/extensions/ExtensionHandlerJava.java
Index: ExtensionHandlerJava.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/extensions/ExtensionHandlerJava.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ExtensionHandlerJava.java 2000/10/30 18:56:28 1.2
+++ ExtensionHandlerJava.java 2000/12/14 16:57:26 1.3
@@ -68,10 +68,10 @@
public abstract class ExtensionHandlerJava extends ExtensionHandler
{
- /** NEEDSDOC Field m_className */
+ /** Extension class name */
protected String m_className = "";
- /** NEEDSDOC Field m_cachedMethods */
+ /** Table of cached methods */
private Hashtable m_cachedMethods = new Hashtable();
/**
@@ -85,8 +85,8 @@
* or a classname depending on the value of lang. If
* srcURL is not null, then scriptSrc is ignored.
* @param scriptSrc the actual script code (if any)
- * NEEDSDOC @param scriptLang
- * NEEDSDOC @param className
+ * @param scriptLang the scripting language
+ * @param className the extension class name
*/
protected ExtensionHandlerJava(String namespaceUri, String scriptLang,
String className)
@@ -105,7 +105,7 @@
* @param methodArgs An array of the XObject arguments to be used for
* function mangling.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The given method from the method cache
*/
public Object getFromCache(Object methodKey, Object objType,
Object[] methodArgs)
@@ -122,9 +122,9 @@
* @param objType A Class object or instance object representing the type
* @param methodArgs An array of the XObject arguments to be used for
* function mangling.
- * NEEDSDOC @param methodObj
+ * @param methodObj A Class object or instance object representing the method
*
- * NEEDSDOC ($objectName$) @return
+ * @return The cached method object
*/
public Object putToCache(Object methodKey, Object objType,
Object[] methodArgs, Object methodObj)
1.12 +4 -3 xml-xalan/java/src/org/apache/xalan/extensions/ExtensionsTable.java
Index: ExtensionsTable.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/extensions/ExtensionsTable.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- ExtensionsTable.java 2000/12/03 21:12:35 1.11
+++ ExtensionsTable.java 2000/12/14 16:57:27 1.12
@@ -64,7 +64,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class ExtensionsTable <needs-comment/>
+ * Class holding a table registered extension namespace handlers
*/
public class ExtensionsTable
{
@@ -112,7 +112,8 @@
* given namespace.
* @param extns A valid extension namespace.
*
- * NEEDSDOC ($objectName$) @return
+ * @return ExtensionHandler object that represents the
+ * given namespace.
*/
public ExtensionHandler get(String extns)
{
@@ -175,7 +176,7 @@
* Execute the element-available() function.
* @param ns the URI of namespace in which the function is needed
* @param funcName the function name being tested
- * NEEDSDOC @param elemName
+ * @param elemName name of element being tested
*
* @return whether the given function is available or not.
*
1.8 +16 -16 xml-xalan/java/src/org/apache/xalan/extensions/XSLProcessorContext.java
Index: XSLProcessorContext.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/extensions/XSLProcessorContext.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- XSLProcessorContext.java 2000/11/23 04:57:18 1.7
+++ XSLProcessorContext.java 2000/12/14 16:57:27 1.8
@@ -90,11 +90,11 @@
* Create a processor context to be passed to an extension.
* (Notice it is a package-only constructor).
*
- * NEEDSDOC @param transformer
- * NEEDSDOC @param stylesheetTree
- * NEEDSDOC @param sourceTree
- * NEEDSDOC @param sourceNode
- * NEEDSDOC @param mode
+ * @param transformer non-null transformer instance
+ * @param stylesheetTree The owning stylesheet
+ * @param sourceTree The source document
+ * @param sourceNode The current source node
+ * @param mode the current mode being executed.
*/
public XSLProcessorContext(TransformerImpl transformer,
Stylesheet stylesheetTree, Node sourceTree,
@@ -108,65 +108,65 @@
this.sourceNode = sourceNode;
}
- /** NEEDSDOC Field transformer */
+ /** An instance of a transformer */
private TransformerImpl transformer;
/**
* Get the transformer.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the transformer instance for this context
*/
public TransformerImpl getTransformer()
{
return transformer;
}
- /** NEEDSDOC Field stylesheetTree */
+ /** The owning stylesheet for this context */
private Stylesheet stylesheetTree;
/**
* Get the Stylesheet being executed.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the Stylesheet being executed.
*/
public Stylesheet getStylesheet()
{
return stylesheetTree;
}
- /** NEEDSDOC Field sourceTree */
+ /** The root of the source tree being executed. */
private Node sourceTree;
/**
* Get the root of the source tree being executed.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the root of the source tree being executed.
*/
public Node getSourceTree()
{
return sourceTree;
}
- /** NEEDSDOC Field sourceNode */
+ /** the current context node. */
private Node sourceNode;
/**
* Get the current context node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the current context node.
*/
public Node getContextNode()
{
return sourceNode;
}
- /** NEEDSDOC Field mode */
+ /** the current mode being executed. */
private QName mode;
/**
* Get the current mode being executed.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the current mode being executed.
*/
public QName getMode()
{
@@ -178,7 +178,7 @@
* This is public for access by extensions.
*
*
- * NEEDSDOC @param stylesheetTree
+ * @param stylesheetTree The owning stylesheet
* @param obj the Java object to output. If its of an X<something> type
* then that conversion is done first and then sent out.
*