dleslie 01/02/08 10:59:12
Modified: c/src/XalanTransformer XalanCAPI.h
XalanTransformerOutputStream.hpp
Log:
Editorial pass on comments.
Revision Changes Path
1.7 +21 -25 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.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- XalanCAPI.h 2001/02/08 15:38:52 1.6
+++ XalanCAPI.h 2001/02/08 18:58:58 1.7
@@ -65,10 +65,10 @@
/**
* This is a simple C interface for the class XalanTransformer. 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.
*/
#if defined(__cplusplus)
extern "C"
@@ -84,13 +84,13 @@
* Callback function passed to XalanTransformToHandler.
* Used to process transform output in blocks of data.
* Caller is responsible for streaming or copying data to a user
- * allocated buffer. Called should not attempt to write to or
+ * allocated buffer. Caller should not attempt to write to or
* free this data. Xalan will reuse the same buffer and free it
* upon termination.
*
- * The callback should return the number of bytes written and this
- * number should match the length received. Otherwise, the function
- * XalanTransformToHandler will terminate and return a error status.
+ * 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.
*
* static unsigned long xalanOutputHandler(const void* data, unsigned
long length, const void *handle);
*
@@ -112,7 +112,7 @@
typedef void (*XalanFlushHandlerType) (const void*);
/**
- * This is a typedef to workaround limitations with
+ * This is a typedef to work around limitations with
* the XALAN_TRANSFORMER_EXPORT_FUNCTION macro.
*/
typedef const char* XalanCCharPtr;
@@ -151,8 +151,8 @@
/**
* 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 stylesheet file to the input
+ * file and write the transformation result to a new output file.
*
* @param theXMLFileName filename of XML input source
* @param theXSLFileName filename of stylesheet source
@@ -169,8 +169,8 @@
/**
* Transform the XML source tree to a dynamically allocated buffer.
- * The processor will process the input file, the stylesheet file,
- * and assign the address of dynamically allocated result to a
+ * The processor will apply the stylesheet file to the input file
+ * and assign the address of the dynamically allocated result to a
* user defined pointer. The user must call XalanFreeData with the
* address of this pointer.
*
@@ -198,13 +198,13 @@
/**
* 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 pre-allocated
- * blocks. Once the transform is completed a second callback, to
- * flush the buffer, will be called. You can pass in NULL if you
- * do not wish to implement a flush callback. Xalan will release
- * any memory allocated upon termination and data passed to the
- * callback is not guaranteed to be null terminated.
+ * The processor will apply the stylesheet file to the input file
+ * and allocate the transformation result to a callback function
+ * in pre-allocated blocks. Once the transformation is complete,
+ * a second callback, to flush the buffer, is called. You can pass
+ * in NULL if you do not wish to implement a flush callback. Xalan
+ * will release any memory allocated upon termination, and data passed
+ * to the callback is not guaranteed to be null terminated.
*
* - See XalanOutputHandlerType and XalanFlushHandlerType for more
* details.
@@ -227,8 +227,8 @@
XalanFlushHandlerType theFlushHandler);
/**
- * Returns the last error that occured as a
- * result of callaing transform.
+ * Returns the last error that occurred as a
+ * result of calling transform.
*
* The signiture for following function is really:
* const char*
@@ -246,7 +246,3 @@
#endif // XALAN_CAPI_HEADER_GUARD_1357924680
-
-
-
-
1.5 +2 -2
xml-xalan/c/src/XalanTransformer/XalanTransformerOutputStream.hpp
Index: XalanTransformerOutputStream.hpp
===================================================================
RCS file:
/home/cvs/xml-xalan/c/src/XalanTransformer/XalanTransformerOutputStream.hpp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- XalanTransformerOutputStream.hpp 2001/02/08 15:38:37 1.4
+++ XalanTransformerOutputStream.hpp 2001/02/08 18:59:02 1.5
@@ -77,14 +77,14 @@
-// A class for output to a user define (callback) function.
+// A class for output to a user defined (callback) function.
class XALAN_TRANSFORMER_EXPORT XalanTransformerOutputStream : public
XalanOutputStream
{
public:
/**
* Construct a XalanTransformerOutputStream instance for output to a
- * user define (callback) function.
+ * user defined (callback) function.
*
* @param theOutputHandle void pointer passed through to callback.
* @param theOutputHandler a user defined (callback) function.
