Hi all,
I have attached a replacement patch to this email because I had overlooked
some typos and things I'd like to change. So please disregard the one
attached to the email I'm replying to and instead use the patch attached
to this email.
Best regards, mabri
- Original Message -
From: Matthew Brincke mabr...@ymail.com
To: podofo-users@lists.sourceforge.net podofo-users@lists.sourceforge.net
CC:
Date: Saturday 22 August 2015, 2:02 am
Subject: [Podofo-users] PdfStream and PdfFilter documentation fixes
Hi all,
I have attached a patch with clarifications, formatting
and typo fixes to PdfStream.h and PdfFilter.h (please
review them, if accepted, please apply). I only post this
late because I had problems with my Internet access, I'm sorry.
Best regards, mabri
--
___
Podofo-users mailing list
Podofo-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/podofo-users
PdfStream and PdfFilter documentation fixes/clarifications
Index: src/base/PdfFilter.h
===
--- src/base/PdfFilter.h (revision 1676)
+++ src/base/PdfFilter.h (working copy)
@@ -55,11 +55,11 @@
/** Every filter in PoDoFo has to implement this interface.
*
- * The two methods Encode and Decode have to be implemented
+ * The two methods Encode() and Decode() have to be implemented
* for every filter.
*
- * The output buffers are malloc'ed in the functions and have
- * to be free'd by the caller.
+ * The output buffers are malloc()'ed in the functions and have
+ * to be free()'d by the caller.
*/
class PODOFO_API PdfFilter {
public:
@@ -71,14 +71,14 @@
*/
inline virtual ~PdfFilter();
-/** Check wether encoding is implemented for this filter.
+/** Check whether encoding is implemented for this filter.
*
* \returns true if the filter is able to encode data
*/
virtual bool CanEncode() const = 0;
-/** Encodes a buffer using a filter. The buffer will malloc'ed and
- * has to be free'd by the caller.
+/** Encodes a buffer using a filter. The buffer will malloc()'d and
+ * has to be free()'d by the caller.
*
* This function uses BeginEncode()/EncodeBlock()/EndEncode()
* internally, so it's not safe to use when progressive encoding
@@ -86,8 +86,8 @@
*
* \param pInBuffer input buffer
* \param lInLenlength of the input buffer
- * \param ppOutBuffer pointer to the buffer of the encoded data
- * \param plOutLen pointer to the length of the output buffer
+ * \param ppOutBuffer receives pointer to the buffer of the encoded data
+ * \param plOutLen pointer to where to write the output buffer's length
*/
void Encode( const char* pInBuffer, pdf_long lInLen, char** ppOutBuffer, pdf_long* plOutLen ) const;
@@ -97,9 +97,9 @@
* perform other operations defined by particular filter
* implementations. It calls BeginEncodeImpl().
*
- * \param pOutput encoded data will be written to this stream.
+ * \param pOutput Encoded data will be written to this stream.
*
- * Call EncodeBlock() to encode blocks of data and use EndEncode
+ * Call EncodeBlock() to encode blocks of data and use EndEncode()
* to finish the encoding process.
*
* \see EncodeBlock
@@ -108,7 +108,7 @@
inline void BeginEncode( PdfOutputStream* pOutput );
/** Encode a block of data and write it to the PdfOutputStream
- * specified by BeginEncode. Ownership of the block is not taken
+ * specified by BeginEncode(). Ownership of the block is not taken
* and remains with the caller.
*
* The filter implementation need not immediately process the buffer,
@@ -123,7 +123,7 @@
* \param pBuffer pointer to a buffer with data to encode
* \param lLen length of data to encode.
*
- * Call EndEncode() after all data has been encoded
+ * Call EndEncode() after all data has been encoded.
*
* \see BeginEncode
* \see EndEncode
@@ -138,23 +138,23 @@
*/
inline void EndEncode();
-/** Check wether the decoding is implemented for this filter.
+/** Check whether the decoding is implemented for this filter.
*
* \returns true if the filter is able to decode data
*/
virtual bool CanDecode() const = 0;
-/** Decodes a buffer using a filter. The buffer will malloc'ed and
- * has to be free'd by the caller.
+/** Decodes a buffer using a filter. The buffer will malloc()'d and
+ * has to be free()'d by the caller.
*
* \param pInBuffer input buffer
* \param lInLenlength of the input buffer
- * \param ppOutBuffer pointer to the buffer of the decoded data
- * \param plOutLen pointer to the length of the output
