dleslie 01/02/08 13:18:20
Modified: c/src/XalanTransformer XalanCAPI.h XalanTransformer.hpp
XalanTransformerOutputStream.cpp
Log:
Editorial pass on comments.
Revision Changes Path
1.8 +4 -4 xml-xalan/c/src/XalanTransformer/XalanCAPI.h
Index: XalanCAPI.h
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XalanTransformer/XalanCAPI.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- XalanCAPI.h 2001/02/08 18:58:58 1.7
+++ XalanCAPI.h 2001/02/08 21:18:09 1.8
@@ -82,15 +82,15 @@
/**
* Callback function passed to XalanTransformToHandler.
- * Used to process transform output in blocks of data.
+ * Used to process transformation output in blocks of data.
* Caller is responsible for streaming or copying data to a user
* allocated buffer. Caller should not attempt to write to or
- * free this data. Xalan will reuse the same buffer and free it
- * upon termination.
+ * free this data. Upon termination, Xalan reuses the same buffer
+ * and frees it.
*
* The callback should return the number of bytes written, and
* this number should match the length received. Otherwise the
- * XalanTransformToHandler function terminates and returns a error
status.
+ * XalanTransformToHandler function terminates and returns an error
status.
*
* static unsigned long xalanOutputHandler(const void* data, unsigned
long length, const void *handle);
*
1.7 +27 -25 xml-xalan/c/src/XalanTransformer/XalanTransformer.hpp
Index: XalanTransformer.hpp
===================================================================
RCS file: /home/cvs/xml-xalan/c/src/XalanTransformer/XalanTransformer.hpp,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- XalanTransformer.hpp 2001/02/08 15:38:47 1.6
+++ XalanTransformer.hpp 2001/02/08 21:18:11 1.7
@@ -110,11 +110,11 @@
/**
* This is a simple C++ interface for some common usage patterns. It's
- * the responsibility of the caller to call initialize and terminate
+ * the user's responsibility to call initialize and terminate
* before creating and after deleting any XalanTransformer instances
- * respectively. As well, releasing any memory allocated from calling
- * XalanTransformToData by calling XalanFreeData.
- */
+ * respectively. After calling XalanTransformToData, the user should
+ * call XalanFreeData to release the memory allocated by that operation.
+*/
class XALAN_TRANSFORMER_EXPORT XalanTransformer
{
public:
@@ -140,8 +140,8 @@
terminate();
/**
- * Returns the last error that occured as a
- * result of callaing transform.
+ * Returns the last error that occurred as a
+ * result of calling transform.
*
* @return error message const character pointer.
*/
@@ -149,10 +149,10 @@
getLastError() const;
/**
- * Transform the source tree to the output in the given result tree
target.
- * The processor will process the input source, the stylesheet source,
- * and transform to the output target. Call internally by all transform
- * overloads.
+ * Transform the source tree to output in the given result tree target.
+ * The processor will apply the the stylesheet source to the input
source
+ * and write the transformation output to the target. Called internally
by
+ * all transform methods.
*
* @param inputSource input source
* @param stylesheetSource stylesheet source
@@ -167,12 +167,12 @@
/**
* Transform the XML source tree to the given result file.
- * The processor will process the input file, the stylesheet file,
- * and transform to new output file.
+ * The processor will apply the the stylesheet source to the input
source
+ * and write the transformation output to the output file.
*
- * @param theXMLFileName filename of XML input source
- * @param theXSLFileName filename of stylesheet source
- * @param theOutFileName filename of output source
+ * @param theXMLFileName filename of XML input file
+ * @param theXSLFileName filename of stylesheet file
+ * @param theOutFileName filename of output file
* @return 0 for success
*/
int
@@ -183,8 +183,8 @@
/**
* Transform the XML source tree to an output stream.
- * The processor will process the input file, the stylesheet file,
- * and transform to an output stream.
+ * The processor will apply the the stylesheet file to the input file
+ * and write the transformation output to the output stream.
*
* @param theXMLFileName filename of XML input source
* @param theXSLFileName filename of stylesheet source
@@ -199,8 +199,8 @@
/**
* Transform the XML source tree to an output stream.
- * The processor will process the input stream, the stylesheet input
- * stream, and transform to an output stream.
+ * The processor will apply the the stylesheet stream to the input
stream
+ * and write the transformation output to the output stream.
*
* @param theXMLInStream a std istream for the input
* @param theXSLInStream a std istream for the input
@@ -215,12 +215,14 @@
/**
* Transform the XML source tree to a callback function.
- * The processor will process the input file, the stylesheet file,
- * and transform to output to a callback function in allocated
- * blocks. Xalan will release any memory allocated upon
- * termination. Data passed to the callback is not guaranteed to
- * be null terminated. - See XalanTransformerOutputStream and
- * XalanOutputHandlerType for more details.
+ * The processor will apply the stylesheet file to the input file
+ * and allocate the transformation result to a callback function
+ * in pre-allocated blocks. Upon termination, Xalan releases any
+ * allocated memory. Data passed to the callback is not guaranteed to
+ * be null terminated.
+ *
+ * - See XalanTransformerOutputStream and XalanOutputHandlerType
+ * for more details.
*
* @param theXMLFileName filename of XML input source
* @param theXSLFileName filename of stylesheet source
1.5 +1 -1
xml-xalan/c/src/XalanTransformer/XalanTransformerOutputStream.cpp
Index: XalanTransformerOutputStream.cpp
===================================================================
RCS file:
/home/cvs/xml-xalan/c/src/XalanTransformer/XalanTransformerOutputStream.cpp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- XalanTransformerOutputStream.cpp 2001/02/08 15:38:45 1.4
+++ XalanTransformerOutputStream.cpp 2001/02/08 21:18:13 1.5
@@ -95,7 +95,7 @@
const size_t theBytesWritten = m_outputHandler(theBuffer,
theBufferLength, m_outputHandle);
// We validate that the number of bytes written equals the number of
bytes sent to
- // the output handler. Otherwise we will stop processing and throw and
exception.
+ // the output handler. Otherwise we will stop processing and throw an
exception.
// Thus the callback can alert us of memory allocation issues or buffer
overflows.
if(theBytesWritten != theBufferLength)
{
