Commit aa2cfad61a1c51e15571c77a8cf70aa872140aca
1 parent
2e4ca7ec
Clarify some comments
Showing
2 changed files
with
5 additions
and
3 deletions
include/qpdf/BufferInputSource.hh
| @@ -28,6 +28,8 @@ | @@ -28,6 +28,8 @@ | ||
| 28 | class BufferInputSource: public InputSource | 28 | class BufferInputSource: public InputSource |
| 29 | { | 29 | { |
| 30 | public: | 30 | public: |
| 31 | + // If own_memory is true, BufferInputSource will delete the buffer | ||
| 32 | + // when finished with it. Otherwise, the caller owns the memory. | ||
| 31 | QPDF_DLL | 33 | QPDF_DLL |
| 32 | BufferInputSource(std::string const& description, Buffer* buf, | 34 | BufferInputSource(std::string const& description, Buffer* buf, |
| 33 | bool own_memory = false); | 35 | bool own_memory = false); |
include/qpdf/InputSource.hh
| @@ -64,9 +64,9 @@ class InputSource | @@ -64,9 +64,9 @@ class InputSource | ||
| 64 | // starting within the range defined by offset and len such that, | 64 | // starting within the range defined by offset and len such that, |
| 65 | // when the input source is positioned at the beginning of that | 65 | // when the input source is positioned at the beginning of that |
| 66 | // sequence, finder.check() returns true. If len is 0, the search | 66 | // sequence, finder.check() returns true. If len is 0, the search |
| 67 | - // proceeds until EOF. If a qualifying pattern these methods | ||
| 68 | - // return true and leave the input source positioned wherever | ||
| 69 | - // check() left it at the end of the matching pattern. | 67 | + // proceeds until EOF. If a qualifying pattern is found, these |
| 68 | + // methods return true and leave the input source positioned | ||
| 69 | + // wherever check() left it at the end of the matching pattern. | ||
| 70 | QPDF_DLL | 70 | QPDF_DLL |
| 71 | bool findFirst(char const* start_chars, | 71 | bool findFirst(char const* start_chars, |
| 72 | qpdf_offset_t offset, size_t len, | 72 | qpdf_offset_t offset, size_t len, |