Commit 0f9086e5094029854eff81cf6480a2284887e5fe

Authored by m-holger
Committed by Jay Berkenbilt
1 parent 8eca9d8f

Fix doc typos

include/qpdf/QPDF.hh
@@ -115,7 +115,7 @@ class QPDF @@ -115,7 +115,7 @@ class QPDF
115 // For certain forensic or investigatory purposes, it may 115 // For certain forensic or investigatory purposes, it may
116 // sometimes be useful to specify the encryption key directly, 116 // sometimes be useful to specify the encryption key directly,
117 // even though regular PDF applications do not provide a way to do 117 // even though regular PDF applications do not provide a way to do
118 - // this. calling setPasswordIsHexKey(true) before calling any of 118 + // this. Calling setPasswordIsHexKey(true) before calling any of
119 // the process methods will bypass the normal encryption key 119 // the process methods will bypass the normal encryption key
120 // computation or recovery mechanisms and interpret the bytes in 120 // computation or recovery mechanisms and interpret the bytes in
121 // the password as a hex-encoded encryption key. Note that we 121 // the password as a hex-encoded encryption key. Note that we
@@ -140,7 +140,7 @@ class QPDF @@ -140,7 +140,7 @@ class QPDF
140 // filter types or override existing ones provided by the library. 140 // filter types or override existing ones provided by the library.
141 // Registered stream filters are used for decoding only as you can 141 // Registered stream filters are used for decoding only as you can
142 // override encoding with stream data providers. For example, you 142 // override encoding with stream data providers. For example, you
143 - // could use this method to support for one of the other filter 143 + // could use this method to add support for one of the other filter
144 // types by using additional third-party libraries that qpdf does 144 // types by using additional third-party libraries that qpdf does
145 // not presently use. The standard filters are implemented using 145 // not presently use. The standard filters are implemented using
146 // QPDFStreamFilter classes. 146 // QPDFStreamFilter classes.
@@ -175,7 +175,7 @@ class QPDF @@ -175,7 +175,7 @@ class QPDF
175 175
176 // By default, any warnings are issued to std::cerr or the error 176 // By default, any warnings are issued to std::cerr or the error
177 // stream specified in a call to setOutputStreams as they are 177 // stream specified in a call to setOutputStreams as they are
178 - // encountered. If this is called with a true value, reporting of 178 + // encountered. If this method is called with a true value, reporting of
179 // warnings is suppressed. You may still retrieve warnings by 179 // warnings is suppressed. You may still retrieve warnings by
180 // calling getWarnings. 180 // calling getWarnings.
181 QPDF_DLL 181 QPDF_DLL
@@ -215,7 +215,7 @@ class QPDF @@ -215,7 +215,7 @@ class QPDF
215 // other objects, some transient and some not. Since what's 215 // other objects, some transient and some not. Since what's
216 // relevant is whether the source QPDF is transient, the method 216 // relevant is whether the source QPDF is transient, the method
217 // must be called on the source QPDF, not the destination one. 217 // must be called on the source QPDF, not the destination one.
218 - // Since this method will make a copy of the stream in RAM, so be 218 + // This method will make a copy of the stream in RAM, so be
219 // sure you have enough memory to simultaneously hold all the 219 // sure you have enough memory to simultaneously hold all the
220 // streams you're copying. 220 // streams you're copying.
221 QPDF_DLL 221 QPDF_DLL
@@ -236,13 +236,13 @@ class QPDF @@ -236,13 +236,13 @@ class QPDF
236 QPDF_DLL 236 QPDF_DLL
237 bool anyWarnings() const; 237 bool anyWarnings() const;
238 238
239 - // Indicate the number of warnings that have been issued so far.  
240 - // Does not clear the list of warnings. 239 + // Indicate the number of warnings that have been issued since the last
  240 + // call to getWarnings. Does not clear the list of warnings.
241 QPDF_DLL 241 QPDF_DLL
242 size_t numWarnings() const; 242 size_t numWarnings() const;
243 243
244 // Return an application-scoped unique ID for this QPDF object. 244 // Return an application-scoped unique ID for this QPDF object.
245 - // This is not a globally unique ID. It is constructing using a 245 + // This is not a globally unique ID. It is constructed using a
246 // timestamp and a random number and is intended to be unique 246 // timestamp and a random number and is intended to be unique
247 // among QPDF objects that are created by a single run of an 247 // among QPDF objects that are created by a single run of an
248 // application. While it's very likely that these are actually 248 // application. While it's very likely that these are actually
@@ -351,7 +351,7 @@ class QPDF @@ -351,7 +351,7 @@ class QPDF
351 // you are going to turn into a form XObject, though you can also 351 // you are going to turn into a form XObject, though you can also
352 // use QPDFPageObjectHelper::getFormXObjectForPage for that 352 // use QPDFPageObjectHelper::getFormXObjectForPage for that
353 // purpose. 353 // purpose.
354 - 354 + //
355 // When copying objects with this method, object structure will be 355 // When copying objects with this method, object structure will be
356 // preserved, so all indirectly referenced indirect objects will 356 // preserved, so all indirectly referenced indirect objects will
357 // be copied as well. This includes any circular references that 357 // be copied as well. This includes any circular references that
libqpdf/qpdf/QPDF_Dictionary.hh
@@ -31,7 +31,7 @@ class QPDF_Dictionary: public QPDFObject @@ -31,7 +31,7 @@ class QPDF_Dictionary: public QPDFObject
31 void replaceKey(std::string const& key, QPDFObjectHandle); 31 void replaceKey(std::string const& key, QPDFObjectHandle);
32 // Remove key, doing nothing if key does not exist 32 // Remove key, doing nothing if key does not exist
33 void removeKey(std::string const& key); 33 void removeKey(std::string const& key);
34 - // If object is null, replace key; otherwise, remove key 34 + // If object is null, remove key; otherwise, replace key
35 void replaceOrRemoveKey(std::string const& key, QPDFObjectHandle); 35 void replaceOrRemoveKey(std::string const& key, QPDFObjectHandle);
36 36
37 protected: 37 protected: