Hi all,
please replace the previous patch (attached to the post I'm
replying to) with the one attached to this post, because it
corrects some oversights I'm sorry for & which prevent correct
application. Please, committers, consider applying this (after
testing, all I wrote remains in effect) to the branch and then
merging it into trunk. I'm going to make another documentation
patch on the weekend (e.g. for PdfString and PdfDocument) which
will be new information (as opposed to most of this which is
just regenerated from current svn as a base).
Best regards, mabri
----- Original Message -----
From: Matthew Brincke <mabr...@ymail.com>
To: "podofo-users@lists.sourceforge.net" <podofo-users@lists.sourceforge.net>
Sent: Thursday, 9 June 2016, 21:35 UTC
Subject: Re: [Podofo-users] Public API method names typo fixes & clarifications
(now both parts)
Hi all,
attached is a patch which includes just the documentation typo fixes
because I wasn't sure whether to include changes breaking (local,
probably also debug) symbols (not really API, but ...).
Please review and (and you're committer) commit (to the branch too
if it's admissible, please). I have *not* made a doxygen run with it
because I haven't got the dev env right now, sorry. I've found some
more typos I couldn't fix also because of that, I'm going to submit
those probably on the weekend.
Best regards, mabri
________________________________
From: Dominik Seichter <domseich...@googlemail.com>
To: zyx <z...@litepdf.cz>
CC: "podofo-users@lists.sourceforge.net" <podofo-users@lists.sourceforge.net>
Sent: Sunday, 7 February 2016, 16:06 UTC
Subject: Re: [Podofo-users] Public API method names typo fixes & clarifications
(now both parts)
Hi all,
I am very greatful to zyx for his work in reviewing and committing patches to
PoDoFo! Thanks again for your efforts! Similarly, all other contributions to
PoDoFo are welcome and these contributions are mostly which keeps the
development ongoin nowadays.
Still, I also agree with zyx that unnecessary API changes should be avoided.
Is there a chance to create a separate patch of yours, which e.g. fixes only
the typos in the documentation and includes all the cleanup which DO NOT break
the API? I am quite sure this could be committed.
Best regards,
Dominik
Best regards,
Dominik
On Mon, Feb 1, 2016 at 10:07 AM, zyx <z...@litepdf.cz> wrote:
On Sun, 2016-01-31 at 23:58 +0000, Matthew Brincke wrote:
>> I read your other e-mail about a build error, AFAIK I have corrected it with
>> the patch attached to this e-mail to be applied in addition to the both
>> parts.
>
> Hi,
>your message is not properly threaded, I wasn't sure you talk to me
>until I read it to the very bottom. Also because other users claimed
>build errors in various environments recently.
>
>> - zyx maintains a product based on PoDoFo himself so I suspect why he acts
>> like this
>
>Heh. Should I take this personally? I do not mind myself, as the
>litePDF maintainer, I do not expect any massive changes being needed in
>the litePDF project, because its main aim is drawing. I wrote both
>reasons in the initial email. I can repeat them here again, in a more
>verbose way, if it'll help:
>
>1) API changes *in any* project is a pita, especially when the API
>change doesn't bring anything new, when it's just a cleanup of function
>names and similar "boring" changes.
>
>2) I am *not* a maintainer of PoDoFo. The only reason why I have commit
>rights to this project is that I did upstream my changes in the PoDoFo
>drawing API. It was an API change and it allowed PoDoFo to have more
>generic drawing API, following PDF specification closely. I believe
>that drawing API change was a pita for exiting users too, but again, it
>was a good change and brought many good things for the drawing. Thus,
>as I am *not* the maintainer, it's not my duty to decide whether any
>API change can be done or not.
>
>Honestly, I do not know why I take care of patches to PoDoFo from this
>list for the past several years. I just want to return back something
>to the community of PoDoFo, the same reason why I did upstream my
>drawing API changes. To let people benefit from the Open Source
>project.
>
>Thus no, this is not a selfish decision from my side. It's only a
>historical experience as a developer and a user of several libraries.
>
> Bye,
> zyx
>
>--
>http://www.litePDF.cz i...@litepdf.cz
>
>
>
_______________________________________________
Podofo-users mailing list
Podofo-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/podofo-users
Index: src/base/PdfError.h
===================================================================
--- src/base/PdfError.h (revision 1767)
+++ src/base/PdfError.h (working copy)
@@ -55,8 +55,8 @@
/** Error Code defines which are used in PdfError to describe the error.
*
- * If you add an error code to this enum, please also add it to PdfError::ErrorName
- * and PdfError::ErrorMessage.
+ * If you add an error code to this enum, please also add it to PdfError::ErrorName()
+ * and PdfError::ErrorMessage().
*
* \see PdfError
*/
@@ -80,7 +80,7 @@
ePdfError_NoXRef, /**< The PDF file has no or an invalid XRef table. */
ePdfError_NoTrailer, /**< The PDF file has no or an invalid trailer. */
ePdfError_NoNumber, /**< A number was expected in the PDF file, but the read string is no number. */
- ePdfError_NoObject, /**< A object was expected and non was found. */
+ ePdfError_NoObject, /**< A object was expected and none was found. */
ePdfError_NoEOFToken, /**< The PDF file has no or an invalid EOF marker. */
ePdfError_InvalidTrailerSize, /**< The trailer size is invalid. */
@@ -102,7 +102,7 @@
ePdfError_InvalidContentStream, /**< The content stream is invalid due to mismatched context pairing or other problems */
ePdfError_UnsupportedFilter, /**< The requested filter is not yet implemented. */
- ePdfError_UnsupportedFontFormat, /**< This font format is not supported by PoDoFO. */
+ ePdfError_UnsupportedFontFormat, /**< This font format is not supported by PoDoFo. */
ePdfError_ActionAlreadyPresent, /**< An Action was already present when trying to add a Destination */
ePdfError_WrongDestinationType, /**< The requested field is not available for the given destination type */
@@ -114,15 +114,15 @@
ePdfError_MutexError, /**< Error during a mutex operation */
- ePdfError_UnsupportedImageFormat, /**< This image format is not supported by PoDoFO. */
+ ePdfError_UnsupportedImageFormat, /**< This image format is not supported by PoDoFo. */
ePdfError_CannotConvertColor, /**< This color format cannot be converted. */
ePdfError_NotImplemented, /**< This feature is currently not implemented. */
- ePdfError_DestinationAlreadyPresent,/**< An destination was already present when trying to add a Action */
+ ePdfError_DestinationAlreadyPresent,/**< An destination was already present when trying to add an Action */
ePdfError_ChangeOnImmutable, /**< Changing values on immutable objects is not allowed. */
- ePdfError_NotCompiled, /**< This feature was disabled during compile time. */
+ ePdfError_NotCompiled, /**< This feature was disabled at compile time. */
ePdfError_Unknown = 0xffff /**< Unknown error */
};
@@ -180,7 +180,7 @@
PdfErrorInfo();
PdfErrorInfo( int line, const char* pszFile, const char* pszInfo );
PdfErrorInfo( int line, const char* pszFile, const wchar_t* pszInfo );
- PdfErrorInfo( const PdfErrorInfo & rhs );
+ PdfErrorInfo( const PdfErrorInfo & rhs );
const PdfErrorInfo & operator=( const PdfErrorInfo & rhs );
@@ -196,7 +196,7 @@
int m_nLine;
std::string m_sFile;
std::string m_sInfo;
- std::wstring m_swInfo;
+ std::wstring m_swInfo;
};
@@ -377,13 +377,13 @@
static const char* ErrorMessage( EPdfError eCode );
/** Log a message to the logging system defined for PoDoFo.
- * \param eLogSeverity the sevirity of the log message
+ * \param eLogSeverity the severity of the log message
* \param pszMsg the message to be logged
*/
static void LogMessage( ELogSeverity eLogSeverity, const char* pszMsg, ... );
/** Log a message to the logging system defined for PoDoFo.
- * \param eLogSeverity the sevirity of the log message
+ * \param eLogSeverity the severity of the log message
* \param pszMsg the message to be logged
*/
static void LogMessage( ELogSeverity eLogSeverity, const wchar_t* pszMsg, ... );
@@ -415,9 +415,9 @@
/** Log a message to the logging system defined for PoDoFo.
*
* This call does not check if logging is enabled and always
- * prints the error message
+ * prints the error message.
*
- * \param eLogSeverity the sevirity of the log message
+ * \param eLogSeverity the severity of the log message
* \param pszMsg the message to be logged
*/
static void LogErrorMessage( ELogSeverity eLogSeverity, const char* pszMsg, ... );
@@ -427,7 +427,7 @@
* This call does not check if logging is enabled and always
* prints the error message
*
- * \param eLogSeverity the sevirity of the log message
+ * \param eLogSeverity the severity of the log message
* \param pszMsg the message to be logged
*/
static void LogErrorMessage( ELogSeverity eLogSeverity, const wchar_t* pszMsg, ... );
Index: src/base/PdfOutputStream.h
===================================================================
--- src/base/PdfOutputStream.h (revision 1767)
+++ src/base/PdfOutputStream.h (working copy)
@@ -165,9 +165,9 @@
*
* The internal buffer is now owned by the caller
* and will not be deleted by PdfMemoryOutputStream.
- * Further calls to write are not allowed.
+ * Further calls to Write() are not allowed.
*
- * The caller has to free the returned malloc'ed buffer!
+ * The caller has to free() the returned malloc()'ed buffer!
*/
inline char* TakeBuffer();
Index: src/base/PdfParser.h
===================================================================
--- src/base/PdfParser.h (revision 1767)
+++ src/base/PdfParser.h (working copy)
@@ -87,7 +87,7 @@
* \param pVecObjects vector to write the parsed PdfObjects to
* \param pszFilename filename of the file which is going to be parsed
* \param bLoadOnDemand If true all objects will be read from the file at
- * the time they are accesed first.
+ * the time they are accessed first.
* If false all objects will be read immediately.
* This is faster if you do not need the complete PDF
* file in memory.
@@ -94,7 +94,7 @@
*
* This might throw a PdfError( ePdfError_InvalidPassword ) exception
* if a password is required to read this PDF.
- * Call SetPassword with the correct password in this case.
+ * Call SetPassword() with the correct password in this case.
*
* \see SetPassword
*/
@@ -109,7 +109,7 @@
* \param pVecObjects vector to write the parsed PdfObjects to
* \param pszFilename filename of the file which is going to be parsed
* \param bLoadOnDemand If true all objects will be read from the file at
- * the time they are accesed first.
+ * the time they are accessed first.
* If false all objects will be read immediately.
* This is faster if you do not need the complete PDF
* file in memory.
@@ -116,10 +116,10 @@
*
* This might throw a PdfError( ePdfError_InvalidPassword ) exception
* if a password is required to read this PDF.
- * Call SetPassword with the correct password in this case.
+ * Call SetPassword() with the correct password in this case.
*
* This is an overloaded member function to allow working
- * with unicode characters. On Unix systes you can also path
+ * with unicode characters. On Unix systems you can also pass
* UTF-8 to the const char* overload.
*
* \see SetPassword
@@ -135,7 +135,7 @@
* \param pBuffer buffer containing a PDF file in memory
* \param lLen length of the buffer containing the PDF file
* \param bLoadOnDemand If true all objects will be read from the file at
- * the time they are accesed first.
+ * the time they are accessed first.
* If false all objects will be read immediately.
* This is faster if you do not need the complete PDF
* file in memory.
@@ -142,7 +142,7 @@
*
* This might throw a PdfError( ePdfError_InvalidPassword ) exception
* if a password is required to read this PDF.
- * Call SetPassword with the correct password in this case.
+ * Call SetPassword() with the correct password in this case.
*
* \see SetPassword
*/
@@ -154,7 +154,7 @@
* \param pVecObjects vector to write the parsed PdfObjects to
* \param rDevice read from this PdfRefCountedInputDevice
* \param bLoadOnDemand If true all objects will be read from the file at
- * the time they are accesed first.
+ * the time they are accessed first.
* If false all objects will be read immediately.
* This is faster if you do not need the complete PDF
* file in memory.
@@ -161,7 +161,7 @@
*
* This might throw a PdfError( ePdfError_InvalidPassword ) exception
* if a password is required to read this PDF.
- * Call SetPassword with the correct password in this case.
+ * Call SetPassword() with the correct password in this case.
*
* \see SetPassword
*/
@@ -176,7 +176,7 @@
*
* \param pszFilename filename of the file which is going to be parsed
* \param bLoadOnDemand If true all objects will be read from the file at
- * the time they are accesed first.
+ * the time they are accessed first.
* If false all objects will be read immediately.
* This is faster if you do not need the complete PDF
* file in memory.
@@ -184,7 +184,7 @@
*
* This might throw a PdfError( ePdfError_InvalidPassword ) exception
* if a password is required to read this PDF.
- * Call SetPassword with the correct password in this case.
+ * Call SetPassword() with the correct password in this case.
*
* \see SetPassword
*/
@@ -219,7 +219,7 @@
* \param pBuffer buffer containing a PDF file in memory
* \param lLen length of the buffer containing the PDF file
* \param bLoadOnDemand If true all objects will be read from the file at
- * the time they are accesed first.
+ * the time they are accessed first.
* If false all objects will be read immediately.
* This is faster if you do not need the complete PDF
* file in memory.
@@ -227,7 +227,7 @@
*
* This might throw a PdfError( ePdfError_InvalidPassword ) exception
* if a password is required to read this PDF.
- * Call SetPassword with the correct password in this case.
+ * Call SetPassword() with the correct password in this case.
*
* \see SetPassword
*/
@@ -237,7 +237,7 @@
*
* \param rDevice the input device to read from
* \param bLoadOnDemand If true all objects will be read from the file at
- * the time they are accesed first.
+ * the time they are accessed first.
* If false all objects will be read immediately.
* This is faster if you do not need the complete PDF
* file in memory.
@@ -245,7 +245,7 @@
*
* This might throw a PdfError( ePdfError_InvalidPassword ) exception
* if a password is required to read this PDF.
- * Call SetPassword with the correct password in this case.
+ * Call SetPassword() with the correct password in this case.
*
* \see SetPassword
*/
@@ -314,13 +314,13 @@
const PdfEncrypt* GetEncrypt() const { return m_pEncrypt; }
/**
- * Takes the encryption object fro mthe parser. The internal handle will be set
+ * Gives the encryption object from the parser. The internal handle will be set
* to NULL and the ownership of the object is given to the caller.
*
* Only call this if you need access to the encryption object
* before deleting the parser.
*
- * \returns the parsers encryption object or NULL if the read PDF file was not encrypted
+ * \returns the parser's encryption object, or NULL if the read PDF file was not encrypted.
*/
inline PdfEncrypt* TakeEncrypt();
@@ -354,7 +354,7 @@
* Strict parsing is by default disabled.
*
* If you enable strict parsing, PoDoFo will fail
- * on a few more common PDF failures. Please not
+ * on a few more common PDF failures. Please note
* that PoDoFo's parser is by default very strict
* already and does not recover from e.g. wrong XREF
* tables.
@@ -530,10 +530,10 @@
void ReadNextTrailer();
- /** Checks for the existence of the %%EOF marker at the end of the file
+ /** Checks for the existence of the %%EOF marker at the end of the file.
* When strict mode is off it will also attempt to setup the parser to ignore
- * any garbage after the last %%EOF marker
- * Simply raises an error if there is a problem with the marker
+ * any garbage after the last %%EOF marker.
+ * Simply raises an error if there is a problem with the marker.
*
*/
void CheckEOFMarker();
@@ -555,8 +555,8 @@
const PdfString & GetDocumentId();
/** Determines the correct version of the PDF
- * from the document catalog (if available).
- * as, PDF > 1.4 allows updating the version.
+ * from the document catalog (if available),
+ * as PDF > 1.4 allows updating the version.
*
* If no catalog dictionary is present or no /Version
* key is available, the version from the file header will
Index: src/base/PdfTokenizer.cpp
===================================================================
--- src/base/PdfTokenizer.cpp (revision 1767)
+++ src/base/PdfTokenizer.cpp (working copy)
@@ -209,7 +209,7 @@
int c;
pdf_int64 counter = 0;
- // check first if there are quequed tokens and return them first
+ // check first if there are queued tokens and return them first
if( m_deqQueque.size() )
{
TTokenizerPair pair = m_deqQueque.front();
@@ -810,7 +810,7 @@
// Some weird PDFs even use them.
rVariant = PdfName();
- // Queque the token again
+ // Enqueue the token again
if( gotToken )
QuequeToken( pszToken, eType );
}
Index: src/base/PdfTokenizer.h
===================================================================
--- src/base/PdfTokenizer.h (revision 1767)
+++ src/base/PdfTokenizer.h (working copy)
@@ -234,8 +234,8 @@
*/
void ReadName( PdfVariant& rVariant );
- /** Add a token to the queque of tokens.
- * GetNextToken() will return all quequed tokens first before
+ /** Add a token to the queue of tokens.
+ * GetNextToken() will return all enqueued tokens first before
* reading new tokens from the input device.
*
* \param pszToken string of the token
@@ -257,8 +257,8 @@
static const char * const s_whitespaceMap;
static const char s_octMap[]; ///< Map of bool values, if a certain char
///< is a valid octal digit
- static const char * const s_escMap; ///< Mapping of escape sequences to there value
- static const char * const s_hexMap; ///< Mapping of hex characters to there value
+ static const char * const s_escMap; ///< Mapping of escape sequences to their value
+ static const char * const s_hexMap; ///< Mapping of hex characters to their value
TTokenizerQueque m_deqQueque;
Index: src/base/PdfVecObjects.cpp
===================================================================
--- src/base/PdfVecObjects.cpp (revision 1767)
+++ src/base/PdfVecObjects.cpp (working copy)
@@ -264,7 +264,7 @@
if( it.first != it.second && !m_lstFreeObjects.empty() )
{
// Be sure that no reference is added twice to free list
- PdfError::DebugMessage( "Adding %d to freelist, is already contained !!", rReference.ObjectNumber() );
+ PdfError::DebugMessage( "Adding %d to free list, is already contained in it!", rReference.ObjectNumber() );
return;
}
else
Index: src/doc/PdfField.h
===================================================================
--- src/doc/PdfField.h (revision 1767)
+++ src/doc/PdfField.h (working copy)
@@ -924,7 +924,7 @@
*
* \param bCombs if true enable division into combs
*
- * By default coms are disabled. Requires the max len
+ * By default combs are disabled. Requires the max-len
* property to be set.
*
* \see SetMaxLen
@@ -932,7 +932,7 @@
inline void SetCombs( bool bCombs );
/**
- * \returns true if the text field is divided in to equal combs
+ * \returns true if the text field has a division into equal combs set on it
*/
inline bool IsCombs() const;
Index: src/doc/PdfMemDocument.cpp
===================================================================
--- src/doc/PdfMemDocument.cpp (revision 1767)
+++ src/doc/PdfMemDocument.cpp (working copy)
@@ -166,8 +166,8 @@
if( pParser->GetEncrypted() )
{
- // All PdfParserObjects have a pointer to the PdfEncrypt obkect
- // So we have to take ownership of it.
+ // All PdfParser instances have a pointer to a PdfEncrypt object.
+ // So we have to take ownership of it (command the parser to give it).
delete m_pEncrypt;
m_pEncrypt = pParser->TakeEncrypt();
}
Index: src/doc/PdfSignOutputDevice.cpp
===================================================================
--- src/doc/PdfSignOutputDevice.cpp (revision 1767)
+++ src/doc/PdfSignOutputDevice.cpp (working copy)
@@ -106,7 +106,7 @@
size_t PdfSignOutputDevice::GetSignatureSize()const
{
- return (m_pSignatureBeacon == NULL)?0:(m_pSignatureBeacon->data().size()/2);
+ return (m_pSignatureBeacon == NULL) ? 0 : ( m_pSignatureBeacon->GetData().size() / 2 );
}
void PdfSignOutputDevice::SetSignature(const PdfData &sigData)
@@ -205,12 +205,12 @@
if(lLen==0) return numRead;
}
}
- // shift at the end of beacon
- if( (pos+numRead)>= m_sBeaconPos &&
- pos < (m_sBeaconPos+(m_pSignatureBeacon->data().size()+2) )
- ) {
- m_pRealDevice->Seek(m_sBeaconPos+(m_pSignatureBeacon->data().size()+2) );
- }
+ // shift at the end of beacon
+ if ( (pos + numRead) >= m_sBeaconPos &&
+ pos < ( m_sBeaconPos + (m_pSignatureBeacon->data().size() + 2) )
+ ) {
+ m_pRealDevice->Seek( m_sBeaconPos + (m_pSignatureBeacon->data().size() + 2) );
+ }
// read after beacon
lLen = PODOFO_MIN(lLen, m_pRealDevice->GetLength()-m_pRealDevice->Tell());
if(lLen==0) return numRead;
@@ -220,10 +220,10 @@
void PdfSignOutputDevice::Write( const char* pBuffer, size_t lLen )
{
// Check if data with beacon
- if(m_pSignatureBeacon!=NULL)
+ if(m_pSignatureBeacon != NULL)
{
- const std::string &data = m_pSignatureBeacon->data();
- if(data.size()<=lLen)
+ const std::string & data = m_pSignatureBeacon->data();
+ if(data.size() <= lLen)
{
const char *pStart = pBuffer;
const char *pStop = pStart + (lLen-data.size());
Index: src/doc/PdfSignatureField.cpp
===================================================================
--- src/doc/PdfSignatureField.cpp (revision 1767)
+++ src/doc/PdfSignatureField.cpp (working copy)
@@ -123,16 +123,16 @@
{
// Prepare source data
size_t lSigLen = sSignatureData.data().size();
- char* pData = static_cast<char*>(podofo_malloc(lSigLen+2));
- if (!pData)
- {
- PODOFO_RAISE_ERROR(ePdfError_OutOfMemory);
+ char* pData = static_cast<char*>(podofo_malloc( lSigLen + 2 ));
+ if (!pData)
+ {
+ PODOFO_RAISE_ERROR(ePdfError_OutOfMemory);
}
-
- pData[0]='<';
- pData[lSigLen+1]='>';
- memcpy(pData+1, sSignatureData.data().c_str(), lSigLen);
- PdfData signatureData(pData, lSigLen+2);
+
+ pData[0] = '<';
+ pData[lSigLen + 1] = '>';
+ memcpy(pData + 1, sSignatureData.data().c_str(), lSigLen);
+ PdfData signatureData(pData, lSigLen + 2);
podofo_free(pData);
// Content of the signature
if( !m_pSignatureObj )
Index: test/FilterTest/FilterTest.cpp
===================================================================
--- test/FilterTest/FilterTest.cpp (revision 1767)
+++ test/FilterTest/FilterTest.cpp (working copy)
@@ -127,7 +127,7 @@
printf("\t-> Test succeeded!\n");
}
-void test_filter_queque( const char* pBuffer, long lLen )
+void test_filter_queue( const char* pBuffer, long lLen )
{
char* pEncoded;
pdf_long lEncoded;
@@ -291,8 +291,8 @@
}
- test_filter_queque( pTestBuffer1, lTestLength1 );
- test_filter_queque( pTestBuffer2, lTestLength2 );
+ test_filter_queue( pTestBuffer1, lTestLength1 );
+ test_filter_queue( pTestBuffer2, lTestLength2 );
test_stream( pTestBuffer1, lTestLength1 );
test_stream( pTestBuffer2, lTestLength2 );
Index: tools/podofoimpose/pdftranslator.cpp
===================================================================
--- tools/podofoimpose/pdftranslator.cpp (revision 1767)
+++ tools/podofoimpose/pdftranslator.cpp (working copy)
@@ -125,7 +125,7 @@
}
catch(PdfError& e)
{
- std::cerr<<"Unable to create Document: " <<PdfError::ErrorMessage( e. GetError() )<<endl;
+ std::cerr << "Unable to create Document: " << PdfError::ErrorMessage( e.GetError() ) << std::endl;
return;
}
}
------------------------------------------------------------------------------
What NetFlow Analyzer can do for you? Monitors network bandwidth and traffic
patterns at an interface-level. Reveals which users, apps, and protocols are
consuming the most bandwidth. Provides multi-vendor support for NetFlow,
J-Flow, sFlow and other flows. Make informed decisions using capacity
planning reports. https://ad.doubleclick.net/ddm/clk/305295220;132659582;e
_______________________________________________
Podofo-users mailing list
Podofo-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/podofo-users
